-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7fc9a47
commit ae66f7a
Showing
2 changed files
with
72 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,7 +17,8 @@ | |
| <div class="wrapper"> | ||
| <header> | ||
| <h1 class="header">SMACK'D</h1> | ||
| <p class="header">An Eclipse plugin for visualizing SMACK</p> | ||
| <p class="header">An Eclipse plugin for visually debugging SMACK</p> | ||
| <p class="header">Get the source</p> | ||
|
|
||
| <ul> | ||
| <li class="download"><a class="buttons" href="https://github.com/smackers/smackd/zipball/master">Download ZIP</a></li> | ||
|
|
@@ -31,35 +32,94 @@ | |
| </header> | ||
| <section> | ||
| <h3> | ||
| <a name="welcome-to-github-pages" class="anchor" href="#welcome-to-github-pages"><span class="octicon octicon-link"></span></a>Welcome to GitHub Pages.</h3> | ||
| <a name="overview" class="anchor" href="#overview"><span class="octicon octicon-link"></span></a>Overview</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>SMACK'D is an Eclipse plugin for visually debugging software analyzed by <a href='https://https://github.com/smackers/smack'>SMACK</a>.</p> | ||
|
|
||
| <pre><code>$ cd your_repo_root/repo_name | ||
| <!-- <pre><code>$ cd your_repo_root/repo_name | ||
| $ git fetch origin | ||
| $ git checkout gh-pages | ||
| </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> | ||
| <!-- <p>If you're using the GitHub for Mac, simply sync your repository and you'll see the new branch.</p> --> | ||
|
|
||
| <h3> | ||
| <a name="designer-templates" class="anchor" href="#designer-templates"><span class="octicon octicon-link"></span></a>Designer Templates</h3> | ||
| <a name="smackd-prerequisites" class="anchor" href="#smackd-prerequisites"><span class="octicon octicon-link"></span></a>SMACK'D Prerequisites</h3> | ||
| <p>SMACK'D requires the following components</p> | ||
| <ul> | ||
| <li>SMACK</li> | ||
| <li>Eclipse | ||
| <ul class="nested"><li>CDT Plugin</li></ul> | ||
| </li> | ||
| </ul> | ||
|
|
||
| <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> | ||
| <h3> | ||
| <a name="getting-smack" class="anchor" href="#getting-smack"><span class="octicon octicon-link"></span></a>Getting SMACK</h3> | ||
|
|
||
| <p>SMACK installation instructions can be found at the <a href='https://github.com/smackers/smack'>SMACK github repo</a></p> | ||
|
|
||
| <h3> | ||
| <a name="rather-drive-stick" class="anchor" href="#rather-drive-stick"><span class="octicon octicon-link"></span></a>Rather Drive Stick?</h3> | ||
| <a name="getting-smackd" class="anchor" href="#getting-smackd"><span class="octicon octicon-link"></span></a>Getting SMACK'D</h3> | ||
|
|
||
| <p>Once SMACK is installed, you need to get the SMACK'D Eclipse plugin.</p> | ||
| <ul> | ||
| <li>From Eclipse, navigate to <i>Help\Install new software...</i></li> | ||
| <li>Add the following software update site | ||
| <ul class="nested"><li><b>http://smackers.github.io/smackd</b></li></ul> | ||
| </li> | ||
| <li>Uncheck the <b>Group items by category</b> box (SMACK'D will be put in a category later)</li> | ||
| <li>Install the SMACK'D plugin (currently called Smack Analyzer - will be updated)</li> | ||
| </ul> | ||
|
|
||
|
|
||
| <h3> | ||
| <a name="configuring-smackd" class="anchor" href="#configuring-smackd"><span class="octicon octicon-link"></span></a>Configuring SMACK'D</h3> | ||
|
|
||
| <p>From the Eclipse preferences window, select the <b>SMACK'D Preferences</b> tab. Configure the paths specific to your machine</p> | ||
| <p><b>NOTE: </b> Includes are currently an issue (which applies to ALL software analyzed by smack, as smack.h must be included). The Eclipse CDT compiler is not currently aware of SMACK - an external instance of LLVM is used by SMACK. As such, unless include paths for the CDT compiler and LLVM converge, only one will work at a time. This is perhaps the next major hurdle for the project - figure out include paths, set some persistent environment variables during the SMACK install script, etc.</p> | ||
|
|
||
| <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> | ||
| <a name="smackd-example" class="anchor" href="#smackd-example"><span class="octicon octicon-link"></span></a>SMACK'D Example</h3> | ||
|
|
||
| <ul> | ||
| <li>Create a new empty C project.</li> | ||
| <li>Create a new .c file</li> | ||
| <li>Clear any Eclipse generated comments/includes</li> | ||
| <li>Copy and paste the code below into the new .c file</li> | ||
| <li>Navigate to <b>SMACK Menu\Run SMACK</b> | ||
| <ul class="nested"><li>You may need to adjust the relative path on the smack.h include</li></ul> | ||
| </li> | ||
| </ul> | ||
|
|
||
| <pre> | ||
| <code>// simple.c | ||
| #include "smack/smack.h" | ||
|
|
||
| int incr(int x) { | ||
| return x + 1; | ||
| } | ||
|
|
||
| int main(void) { | ||
| int a; | ||
|
|
||
| a = 1; | ||
| a = incr(a); | ||
| __SMACK_assert(a == 3); | ||
| return 0; | ||
| }</code> | ||
| </pre> | ||
|
|
||
| <h3> | ||
| <a name="authors-and-contributors" class="anchor" href="#authors-and-contributors"><span class="octicon octicon-link"></span></a>Authors and Contributors</h3> | ||
|
|
||
| <p>UPDATE ME</p> | ||
|
|
||
| <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><a></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> | ||
|
|
||
| <h3> | ||
| <a name="support-or-contact" class="anchor" href="#support-or-contact"><span class="octicon octicon-link"></span></a>Support or Contact</h3> | ||
|
|
||
| <p>UPDATE ME</p> | ||
|
|
||
| <p>Having trouble with Pages? Check out the documentation at <a href="http://help.github.com/pages">http://help.github.com/pages</a> or contact <a href="mailto:[email protected]">[email protected]</a> and we’ll help you sort it out.</p> | ||
| </section> | ||
| <footer> | ||
|
|
||