Create gh-pages branch via GitHub

diff --git a/index.html b/index.html
index 685e5bb5b8eab41e5b04c4ba720e06e9dcd1b8e3..c509cbcdb67bdf2827504d46a50918d4aed525d8 100644 (file)
--- a/index.html
+++ b/index.html
@@ -32,36 +32,55 @@
 
         <section id="main_content">
           <h3>
 
         <section id="main_content">
           <h3>

-<a id="welcome-to-github-pages" class="anchor" href="#welcome-to-github-pages" aria-hidden="true"><span class="octicon octicon-link"></span></a>Welcome to GitHub Pages.</h3>
+<a id="welcome-to-bos-github-page" class="anchor" href="#welcome-to-bos-github-page" aria-hidden="true"><span class="octicon octicon-link"></span></a>Welcome to BOS Github page.</h3>

 
 

-<p>This automatic page generator is the easiest way to create beautiful pages for all of your projects. Author your page content here using GitHub Flavored Markdown, select a template crafted by a designer, and publish. After your page is generated, you can check out the new branch:</p>
+<p>BOS official webpage with forums can be found at <a href="http://bos.asmhackers.net/">BOS</a>. On this page I'll just provide a quickstart for how to try BOS. I'm basing this on OSX, but should be similar for *nix, and the repository has a .bat script for Windows.</p>

 
 

-<pre><code>$ cd your_repo_root/repo_name
-$ git fetch origin
-$ git checkout gh-pages
+<h3>
+<a id="getting-the-os-image-file" class="anchor" href="#getting-the-os-image-file" aria-hidden="true"><span class="octicon octicon-link"></span></a>Getting the OS image file</h3>
+
+<p>Here I'll provide links to the newest available BOS images for direct testing:
+<a href="https://github.com/bubach/BOS/raw/master/bos.img">1.44MB floppy image</a></p>
+
+<p>The image was created on my OSX setup with these commands, using the Homebrew <code>brew install mtools</code> package.</p>
+
+<pre><code>$ mformat -C -f 1440 -v BOS -i ./bos.img ::
+$ hdiutil attach ./bos.img
+$ cp ./kernel/kernel.sys /Volumes/BOS
+$ umount /Volumes/BOS
+$ dd if=./boot/BOS_boot.bin of=/dev/disk1 bs=1 count=512
+$ hdiutil detach /dev/disk1
+$ chmod 0777 ./bos.img

 </code></pre>
 
 </code></pre>
 

-<p>If you're using the GitHub for Mac, simply sync your repository and you'll see the new branch.</p>
+<h3>
+<a id="testing-the-os" class="anchor" href="#testing-the-os" aria-hidden="true"><span class="octicon octicon-link"></span></a>Testing the OS</h3>
+
+<p>To test the OS you will need Bochs, Qemu or a physical floppy driver in your desktop computer. Bochs can be downloaded on OSX with homebrew by first getting the X11 <code>xquartz</code> package. After that is installed, run:</p>
+
+<pre><code>$ brew install homebrew/x11/bochs
+$ bochs -f ./doc/bochsrc-osx.txt
+</code></pre>

 
 <h3>
 
 <h3>

-<a id="designer-templates" class="anchor" href="#designer-templates" aria-hidden="true"><span class="octicon octicon-link"></span></a>Designer Templates</h3>
+<a id="commands" class="anchor" href="#commands" aria-hidden="true"><span class="octicon octicon-link"></span></a>Commands</h3>

 
 

-<p>We've crafted some handsome templates for you to use. Go ahead and continue to layouts to browse through them. You can easily go back to edit your page before publishing. After publishing your page, you can revisit the page generator and switch to another theme. Your Page content will be preserved if it remained markdown format.</p>
+<p>Right now there isn't much you can do in BOS. The available commands will be listed by typing <code>help</code> followed by ENTER. As development goes on, I will go into more detail here.</p>

 
 <h3>
 
 <h3>

-<a id="rather-drive-stick" class="anchor" href="#rather-drive-stick" aria-hidden="true"><span class="octicon octicon-link"></span></a>Rather Drive Stick?</h3>
+<a id="roadmap-and-goals" class="anchor" href="#roadmap-and-goals" aria-hidden="true"><span class="octicon octicon-link"></span></a>Roadmap and goals</h3>

 
 

-<p>If you prefer to not use the automatic generator, push a branch named <code>gh-pages</code> to your repository to create a page manually. In addition to supporting regular HTML content, GitHub Pages support Jekyll, a simple, blog aware static site generator written by our own Tom Preston-Werner. Jekyll makes it easy to create site-wide headers and footers without having to copy them across every page. It also offers intelligent blog support and other advanced templating features.</p>
+<p>After several years with not much happening, I'm now back and fully committed on getting the next version of BOS released - which will focus mainly on a VFS (Virtual File System) abstraction layer for keeping track of storgage devices and filesystems.  Next release will feature the VFS with the updated floppy driver and FAT12 support.</p>

 
 <h3>
 
 <h3>

-<a id="authors-and-contributors" class="anchor" href="#authors-and-contributors" aria-hidden="true"><span class="octicon octicon-link"></span></a>Authors and Contributors</h3>
+<a id="contribute" class="anchor" href="#contribute" aria-hidden="true"><span class="octicon octicon-link"></span></a>Contribute</h3>

 
 

-<p>You can <a href="https://github.com/blog/821" class="user-mention">@mention</a> a GitHub username to generate a link to their profile. The resulting <code>&lt;a&gt;</code> element will link to the contributor's GitHub Profile. For example: In 2007, Chris Wanstrath (<a href="https://github.com/defunkt" class="user-mention">@defunkt</a>), PJ Hyett (<a href="https://github.com/pjhyett" class="user-mention">@pjhyett</a>), and Tom Preston-Werner (<a href="https://github.com/mojombo" class="user-mention">@mojombo</a>) founded GitHub.</p>
+<p>All contributions are welcomed. Be sure to visit the forums first, and announce what you might want to help out with, and then you create pull requests on Github.</p>

 
 <h3>
 <a id="support-or-contact" class="anchor" href="#support-or-contact" aria-hidden="true"><span class="octicon octicon-link"></span></a>Support or Contact</h3>
 
 
 <h3>
 <a id="support-or-contact" class="anchor" href="#support-or-contact" aria-hidden="true"><span class="octicon octicon-link"></span></a>Support or Contact</h3>
 

-<p>Having trouble with Pages? Check out the documentation at <a href="https://help.github.com/pages">https://help.github.com/pages</a> or contact <a href="mailto:support@github.com">support@github.com</a> and we’ll help you sort it out.</p>
+<p>Having trouble? Check out the BOS forums at <a href="https://bos.asmhackers.net/forum">https://bos.asmhackers.net/forum</a> and we’ll help you sort it out.</p>

         </section>
 
         <footer>
         </section>
 
         <footer>

diff --git a/params.json b/params.json
index daaabadc85bcfc61ce8660ab1a9a2cf9249d4fac..04a2bededa8b53588ffa769b6c77e980c0dce2ad 100644 (file)
--- a/params.json
+++ b/params.json
@@ -1 +1 @@
-{"name":"BOS","tagline":"BOS - a small x86 operating system written in Assembly","body":"### Welcome to GitHub Pages.\r\nThis automatic page generator is the easiest way to create beautiful pages for all of your projects. Author your page content here using GitHub Flavored Markdown, select a template crafted by a designer, and publish. After your page is generated, you can check out the new branch:\r\n\r\n```\r\n$ cd your_repo_root/repo_name\r\n$ git fetch origin\r\n$ git checkout gh-pages\r\n```\r\n\r\nIf you're using the GitHub for Mac, simply sync your repository and you'll see the new branch.\r\n\r\n### Designer Templates\r\nWe've crafted some handsome templates for you to use. Go ahead and continue to layouts to browse through them. You can easily go back to edit your page before publishing. After publishing your page, you can revisit the page generator and switch to another theme. Your Page content will be preserved if it remained markdown format.\r\n\r\n### Rather Drive Stick?\r\nIf you prefer to not use the automatic generator, push a branch named `gh-pages` to your repository to create a page manually. In addition to supporting regular HTML content, GitHub Pages support Jekyll, a simple, blog aware static site generator written by our own Tom Preston-Werner. Jekyll makes it easy to create site-wide headers and footers without having to copy them across every page. It also offers intelligent blog support and other advanced templating features.\r\n\r\n### Authors and Contributors\r\nYou can @mention a GitHub username to generate a link to their profile. The resulting `<a>` element will link to the contributor's GitHub Profile. For example: In 2007, Chris Wanstrath (@defunkt), PJ Hyett (@pjhyett), and Tom Preston-Werner (@mojombo) founded GitHub.\r\n\r\n### Support or Contact\r\nHaving trouble with Pages? Check out the documentation at https://help.github.com/pages or contact support@github.com and we’ll help you sort it out.\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}
\ No newline at end of file
+{"name":"BOS","tagline":"BOS - a small x86 operating system written in Assembly","body":"### Welcome to BOS Github page.\r\nBOS official webpage with forums can be found at [BOS](http://bos.asmhackers.net/). On this page I'll just provide a quickstart for how to try BOS. I'm basing this on OSX, but should be similar for *nix, and the repository has a .bat script for Windows.\r\n\r\n\r\n### Getting the OS image file\r\nHere I'll provide links to the newest available BOS images for direct testing:\r\n[1.44MB floppy image](https://github.com/bubach/BOS/raw/master/bos.img)\r\n\r\nThe image was created on my OSX setup with these commands, using the Homebrew `brew install mtools` package.\r\n```\r\n$ mformat -C -f 1440 -v BOS -i ./bos.img ::\r\n$ hdiutil attach ./bos.img\r\n$ cp ./kernel/kernel.sys /Volumes/BOS\r\n$ umount /Volumes/BOS\r\n$ dd if=./boot/BOS_boot.bin of=/dev/disk1 bs=1 count=512\r\n$ hdiutil detach /dev/disk1\r\n$ chmod 0777 ./bos.img\r\n```\r\n\r\n### Testing the OS\r\nTo test the OS you will need Bochs, Qemu or a physical floppy driver in your desktop computer. Bochs can be downloaded on OSX with homebrew by first getting the X11 `xquartz` package. After that is installed, run:\r\n\r\n```\r\n$ brew install homebrew/x11/bochs\r\n$ bochs -f ./doc/bochsrc-osx.txt\r\n````\r\n\r\n### Commands\r\nRight now there isn't much you can do in BOS. The available commands will be listed by typing `help` followed by ENTER. As development goes on, I will go into more detail here.\r\n\r\n### Roadmap and goals\r\nAfter several years with not much happening, I'm now back and fully committed on getting the next version of BOS released - which will focus mainly on a VFS (Virtual File System) abstraction layer for keeping track of storgage devices and filesystems.  Next release will feature the VFS with the updated floppy driver and FAT12 support.\r\n\r\n### Contribute\r\nAll contributions are welcomed. Be sure to visit the forums first, and announce what you might want to help out with, and then you create pull requests on Github.\r\n\r\n### Support or Contact\r\nHaving trouble? Check out the BOS forums at https://bos.asmhackers.net/forum and we’ll help you sort it out.","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}
\ No newline at end of file