Skip to content

Commit

Permalink
Updated readme and help files
Browse files Browse the repository at this point in the history
  • Loading branch information
adamldavis committed Jul 6, 2012
1 parent da778dc commit ceacbc0
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 11 deletions.
14 changes: 9 additions & 5 deletions README.md
@@ -1,13 +1,16 @@
Zeta Code
========================

Go from a 10,000 ft view of the entire project down to any file simply by zooming. Zeta Code is a [ZUI](https://en.wikipedia.org/wiki/Zooming_User_Interface) for programmers.
Go from a 10,000 ft view of the entire project down to any file or method.
Zeta Code is a [ZUI](https://en.wikipedia.org/wiki/Zooming_User_Interface).
Zeta Code is a way to view code as a graph.
It does not mean to replace traditional IDE's, but rather is
a different way to view and manipulate code.
It looks at a project holistically - including imports and dependencies
as top-level objects and breaks out of the ancient code-as-files metaphor.
![https://p.twimg.com/AvwpduGCIAAC0Qa.png:large](https://p.twimg.com/AvwpduGCIAAC0Qa.png:large)

Languages/Frameworks Supported: Java/Maven, Ruby/Gems

* Java/Maven: Tested on itself
* Ruby/Gems: Tested on the Rails project
Languages/Frameworks Supported: Java/Maven, Groovy scripting

Features
--------
Expand All @@ -19,6 +22,7 @@ Features
* Time-Travel: gource-like animation of commit history (git)
* Neo-Edit Editor with syntax highlighting and many other features
* Press F6 in editor for runtime-debugging
* Playground: immediately evaluating groovy

Future Plans
------------
Expand Down
13 changes: 7 additions & 6 deletions resources/com/adamldavis/z/help.html
Expand Up @@ -2,7 +2,7 @@
<html>
<head>
<meta charset="ISO-8859-1">
<title>Z Help</title>
<title>Zeta-Code Help</title>
<style type="text/css">
h1, h2 {color: #333333; background: #E0E0E0}
h1 {font-size: 1.25em}
Expand All @@ -11,9 +11,9 @@
</style>
</head>
<body>
<h1>Z Help</h1>
<h1>Zeta Code Help</h1>
<h2>About</h2>
<p>Z (pronounced "Zeta") is a way to view code as a graph.
<p>Zeta Code is a way to view code as a graph.
It does not mean to replace traditional IDE's, but rather is
a different way to view and manipulate code.
It looks at a project holistically - including imports and dependencies
Expand All @@ -26,7 +26,7 @@ <h2>Supports</h2>

<h2>Getting Started</h2>
<ul>
<li>Start Z</li>
<li>Start Zeta Code</li>
<li>Right-click anywhere - this shows the menu</li>
<li>Click File-->Open</li>
<li>Open an existing Maven-based Java project (directory or pom file).</li>
Expand All @@ -36,17 +36,18 @@ <h2>Navigating around</h2>
<ul>
<li>Left-click on a node to select it.</li>
<li>To go up a level at any time: choose "<b>Go up</b>" in the menu.</li>
<li>Right-click on a node to edit it.</li>
<li>Ctrl-click on a node to edit it.</li>
</ul>

<h2>Editing Files</h2>
<ul>
<li>Your changes are saved every time you hit <i>Enter</i></li>
<li>Additional help is available by hitting <i>F1</i> in the editor.</li>
<li>Esc - exit the editor</li>
</ul>

<h2>License</h2>
<p>Z is covered under a BSD-style license. Copyright 2012, Adam L. Davis, All rights reserved.</p>
<p>Zeta Code is covered under a BSD-style license. Copyright 2012, Adam L. Davis, All rights reserved.</p>

</body>
</html>
1 change: 1 addition & 0 deletions resources/neoedit.html
Expand Up @@ -13,6 +13,7 @@
<h1>Basic Commands</h1>
</p>
<ul>
<li>Esc - exit the editor</li>
<li>
ctrl-C/V/X for copy/paste/cut
</li>
Expand Down

0 comments on commit ceacbc0

Please sign in to comment.