arno
/
bitcoinbook
mirror of https://github.com/bitcoinbook/bitcoinbook
1
0
Fork 0
Code Issues Releases Wiki Activity

updating getting started boilerplate

Browse Source
pull/192/head
Adam Zaremba 10 years ago
parent af4827b8d3
commit 2eba1f7d0a
3 changed files with 26 additions and 29 deletions
Show Stats Download Patch File Download Diff File

55
GETTING-STARTED.html
Unescape View File

@ -1,41 +1,34 @@
<section data-type="chapter">
<h1>Quick Start Guide</h1>
<p>Atlas is currently in its Alpha release; this means that, while we feel the system is ready to be used, it's still actively under development and needs some rigorous testing. That's where you come in! Here are the most important things you need to know to get started.</p>
<p>Atlas is currently in its Beta release; this means that, while we feel the system is ready to be used, it's still actively under development and needs some rigorous testing. That's where you come in! Here are the most important things you need to know to get started.</p>
<section data-type="sect1">
<h1>Atlas (Alpha Release) Is Built on GitHub</h1>
<h1>Atlas (Beta Release) Is Built on Git</h1>
<p>The&nbsp;alpha version of Atlas is built on <a data-original-title="" href="http://github.com" title="">GitHub</a>, one of the leading websites for collaborative file management using the <a data-original-title="" href="http://git-scm.com/" title="">git</a> version-control system. What this means for you is:</p>
<ul>
<li><strong>You need a GitHub account</strong> in order to use Atlas (but if you've logged into Atlas by now, then you know this already).</li>
<li>You can see <strong>all your personal GitHub repos</strong> in Atlas, as well as all the repos you have permission to access within any organizations.</li>
<li><strong>All changes you make in Atlas will be reflected in GitHub, and vice versa.</strong></li>
<li>
<p><strong>You can use <a data-original-title="" href="http://git-scm.com/book/en/Git-Branching-Basic-Branching-and-Merging" title="">branches</a> in Atlas.</strong> On the project dashboard, select the branch you want to edit from the dropdown menu. (However, you cannot currently create new branches through Atlas.)</p>
<figure><img alt="Alt Text" class="icontentsimagesbranchespng" src="images/branches.png" /> <figcaption>The branches dropdown menu shows all existing branches of your project.</figcaption></figure>
</li>
</ul>
<p>The beta version of Atlas is built on <a data-original-title="" href="http://github.com" title="">Git</a>, the powerful version control system that tracks every change in your content, who made it, and when it happened. What this means is that your content is secure and can be rolled back to any previous version if necessary. Git also provides the functionality for seamless collaboration tools (coming soon!).</p>
</section>
<section data-type="sect1">
<h1>Your Projects</h1>
<p>When you sign into Atlas, <strong>the first thing you'll see is a list of all your existing GitHub repos</strong>. If you want to edit or build from an existing project in GitHub, simply find and click the project in the list. To <strong>create a new project</strong>, click the New Project button to the right of the projects list.</p>
<p>When you sign into Atlas, <strong>the first thing you'll see is a list of all your existing projects</strong>. If you want to edit or build from an existing project, simply find and click the project in the list. To <strong>create a new project</strong>, click the New Project button to the right of the projects list.</p>
<figure><img alt="Alt Text" class="icontentsimagesnewprojpng" src="images/newproj.png" /> <figcaption>Click the New Project button in your project list to start fresh.</figcaption></figure>
<figure><img alt="Alt Text" class="icontentsimagesnewprojpng" src="images/newproj.png" />
<figcaption>Click the New Project button in your project list to start fresh.</figcaption>
</figure>
<p>When you create a new project, <strong>Atlas will create a new <a href="http://en.wikipedia.org/wiki/Repository_(version_control)">repo</a> in your GitHub account</strong>, prepopulated with some skeleton files to help you get started. You can edit those files, delete them, or just ignore them completely and create brand-new files of your own.</p>
<p>If you want to start from scratch, you can define the title and description for your project and choose a project template to pre-populate your new repository with some skeleton files based on the kind of project you&rsquo;re making.</p>
<p>Once you select a project or create a new one, <strong>you'll be taken to the project dashboard</strong>, where you'll see a list of all files in the project, and have access to the <a data-type="xref" href="#building_in_atlas">ebook-building tools</a>.</p>
<p>You can also create a new Atlas project by importing an existing project from GitHub or by taking advantage of Atlas&rsquo; conversion services (if included in your pilot agreement).</p>
<p>Once you select a project or create a new one, <strong>you'll be taken to the project dashboard</strong>, where you'll see a list of all files in the project, and have access to the <a data-original-title="" data-type="xref" href="#building_in_atlas" title="">ebook-building tools</a>.</p>
</section>
<section data-type="sect1">
<h1>The Project Dashboard</h1>
<p><strong>The project dashboard is your landing page for each project.</strong> It lists all the files and folders in your repo, lets you switch branches, and gives you quick access to the build tools (more on building <a data-type="xref" href="#building_in_atlas">below</a>).</p>
<p><strong>The project dashboard is your landing page for each project.</strong> It lists all the files and folders in your project and gives you quick access to the build tools (more on building <a data-type="xref" href="#building_in_atlas">below</a>).</p>
<p>From the project dashboard, your next steps will likely be either to start writing or to build your project. <strong>Click a file in your Files pane at left to open it in the editor.</strong> For more about building, <a data-type="xref" href="#building_in_atlas">see below</a>.</p>
</section>
@ -45,7 +38,7 @@
<p><strong>The Atlas editor has <a data-original-title="" data-type="xref" href="#editingenvironments" title="">two writing modes</a></strong>: the Visual Editor and the Code Editor. The Visual Editor&nbsp;is an&nbsp;online authoring environment similar to a word processor, with&nbsp;a formatting toolbar&nbsp;for tagging and styling your content. Documents created in the Visual Editor are stored as <a href="http://en.wikipedia.org/wiki/HTML5">HTML5</a>. The Code Editor allows you to view and edit the underlying HTML5 markup for your document. You can toggle back and forth between the Visual and Code Editors, and changes you make in either mode will immediately be reflected in the other.</p>
<p>While <strong>HTML5 is the default markup language for Atlas content</strong>, Atlas also supports documents written in<strong style="line-height: 1.5em;">&nbsp;<a data-original-title="" data-type="xref" href="#markdownref" title="">Markdown</a>, <a href="http://www.methods.co.nz/asciidoc/">AsciiDoc</a>, and <a href="http://www.docbook.org/">DocBook XML</a></strong><span style="line-height: 1.5em;">. All three of these formats can be edited using the Code Editor.</span></p>
<p>While <strong>HTML5 is the default markup language for Atlas content</strong>, Atlas also supports documents written in<strong style="line-height: 1.5em;">&nbsp;<a data-original-title="" data-type="xref" href="#markdownref" title="">Markdown</a>, <a href="http://www.methods.co.nz/asciidoc/">AsciiDoc</a>, and <a data-original-title="" href="http://www.docbook.org/" title="">DocBook XML</a></strong><span style="line-height: 1.5em;">. All three of these formats can be edited using the Code Editor.</span></p>
<p>In both writing modes, you can <strong>navigate among&nbsp;your files using&nbsp;the Files menu</strong> to the left of the screen, <strong>create and delete files</strong> <strong>and folders</strong>,<strong> <a data-original-title="" data-type="xref" href="#addingimages" title="">upload images</a></strong>, <strong>save your project</strong> (top-right button in the editor, or use the keyboard shortcut ⌘-s/Ctrl+s)&nbsp;and even attach a <strong>custom commit message</strong> to each save (hover over the Save button to open the commit message dialog box).</p>
</section>
@ -53,7 +46,7 @@
<section data-type="sect1">
<h1>Creating a New File</h1>
<p>To create a new file, open the editor (by clicking an existing file), open the Files menu, and click the New File button at bottom left. Give your file a name, and hit Enter.&nbsp;</p>
<p>To create a new file, click the New File button at bottom of the dashboard. Give your file a name, and hit Enter. You can also do this in the Files pane in the editor.</p>
<p>You can also organize your files into folders. To add a folder, click the New Folder button (next to the New File button). You can then click the folder name in the Files menu to open the folder&nbsp;and create new files within it.</p>
@ -69,7 +62,7 @@
<p>When you're finished writing, it's time to build your project so you can share it with the world. <strong>Atlas lets you export your project in <a data-original-title="" data-type="xref" href="#outputformats" title="">four different formats</a></strong>: <a data-original-title="" data-type="xref" href="#formatspdf" title="">PDF</a>, <a data-original-title="" data-type="xref" href="#formatsepub" title="">EPUB</a>, <a data-original-title="" data-type="xref" href="#formatsmobi" title="">MOBI</a>, and <a data-original-title="" data-type="xref" href="#formatshtml" title="">HTML website</a>.</p>
<p>The first time you&nbsp;build, you'll need to choose what formats to build, and what files and settings you want to apply to each format. <strong>Click Build Settings</strong> on the project dashboard to go to the Build Settings page.</p>
<p>The first time you&nbsp;build, you'll need to choose what formats to build, and what files and settings you want to apply to each format; <strong>click Configure</strong> on the project dashboard.</p>
<p>Every format has <a data-type="xref" href="#building">a few different options</a> you can choose. Two options that are common for all formats are:</p>
@ -78,11 +71,13 @@
<li>Collect all index tags you've added and&nbsp;create an <strong>alphabetical index</strong> in your built project. <a data-type="xref" href="#index" title="">Learn more here</a>.</li>
</ul>
<p>Choose a theme for your project (more on that next). Then at the bottom of the Build Settings page, <strong>choose which files to add to the build</strong>, drag the files into the correct order, and then start the build. If the build is successful, you'll get a link to download the file. If it fails, you'll get information about what went wrong (the usual culprit is markup errors).</p>
<p>Choose a theme for your project (more on that next). Then at the bottom of the Configure page, <strong>choose which files to add to the build</strong>, drag the files into the correct order, and then click save. Now you can build from the dashboard.</p>
<p>For subsequent builds, you can <strong>use the Quick Build tools from your project dashboard</strong>. Choose the formats you want to build, and Atlas will automatically use the same settings you initially chose on the Build Settings page.</p>
<p>If the build is successful, you'll get a link to download the file. If it fails, you'll get information about what went wrong (the usual culprit is markup errors).</p>
<figure><img alt="Alt Text" class="icontentsimagesquickbuildspng" src="images/quickbuilds.png" /> <figcaption>The Builds menu on the project dashboard allows you to quickly trigger a build using your previously chosen settings.</figcaption></figure>
<figure><img alt="Alt Text" class="icontentsimagesquickbuildspng" src="images/quickbuilds.png" />
<figcaption>The Builds menu on the project dashboard allows you to quickly trigger a build using your previously chosen settings.</figcaption>
</figure>
</section>
<section data-type="sect1">
@ -90,15 +85,17 @@
<p>All of the Atlas output formats (PDF, EPUB, MOBI, and HTML) are powered by <a href="http://en.wikipedia.org/wiki/Cascading_Style_Sheets">CSS</a>, the standard styling language for the Web. You can write <a data-original-title="" data-type="xref" href="#cssthemes" title="">an entirely new theme using CSS</a>, that can be used for multiple projects, by multiple people, or you can just add <a data-original-title="" data-type="xref" href="#csscustomizations" title="">CSS customizations</a> for your specific project.</p>
<p><strong>To apply a theme to your project</strong>, choose one of the default themes on the Build Settings page, or add a link to your own custom theme.</p>
<p><strong>To apply a theme to your project</strong>, choose one of the default themes on the Configure page, or add a link to your own custom theme.</p>
<figure><img alt="Alt Text" class="icontentsimagesthemepng" src="images/theme.png" /> <figcaption>Add a design to your project on the Build Settings page.</figcaption></figure>
<figure><img alt="Alt Text" class="icontentsimagesthemepng" src="images/theme.png" />
<figcaption>Add a design to your project on the Configure page.</figcaption>
</figure>
</section>
<section data-type="sect1">
<h1>Building Locally with the API</h1>
<p>Atlas gives you the option to <strong>build locally on the command line</strong>, <a data-type="xref" href="#atlas-api">using our API</a>. (Note that you'll still need an internet connection for this to work.) This is great if you prefer to work locally using your own text editor&nbsp;but still want to see the final output.</p>
<p>Atlas gives you the option to <strong>build locally on the command line</strong>, <a data-original-title="" data-type="xref" href="#atlas-api" title="">using our API</a>. (Note that you'll still need an internet connection for this to work.) This is great if you prefer to work locally using your own text editor&nbsp;but still want to see the final output.</p>
</section>
<section data-type="sect1">
@ -106,4 +103,4 @@
<p>For more details on any of the above topics, or for more advanced information, <strong><a data-original-title="" href="http://atlasdocs.oreilly.com/" title="">check out the Atlas documentation</a></strong>.&nbsp;If you&rsquo;re stuck, have specific questions about the app, or just general ideas for improvement, you can contact the Atlas team&nbsp;at&nbsp;<a data-original-title="" href="mailto:atlas@oreilly.com?subject=Atlas%20Feedback" title="">atlas@oreilly.com</a>.</p>
</section>
</section>
</section>

BIN
images/quickbuilds.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 6.1 KiB

BIN
images/theme.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 4.0 KiB

Write Preview
Loading…
Cancel
Save