Skip to content

Commit

Permalink
Adding support documentation and updating formatting on readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pcon committed Jul 21, 2017
1 parent 26669db commit b1f6e4e
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# Solenopsis #
# Solenopsis

Solenopsis is a tool born out of necessity. With no good command-line tool to deploy Salesforce code with it was written to meet a need. Solenopsis is a combination of some ANT scripts to do deployment and Python scripts to do easily manage flags and other neat things like templates.

Right now, all testing and development has been focused on Linux. But patches are welcome to make it truely multi-platform.

## Dependencies ##
## Dependencies
+ Python
+ Ant
+ Python Beatbox (optional)

## Libraries ##
## Libraries
These are the libraries used in Solenopsis. Just a list for them being awesome (and some legal reasons too).

### Ant ###
### Ant
+ [ant](http://ant.apache.org/index.html/)
+ [ant-contrib](http://ant-contrib.sourceforge.net/)
+ [ant-unit](http://ant.apache.org/antlibs/antunit/)
Expand All @@ -22,14 +22,15 @@ These are the libraries used in Solenopsis. Just a list for them being awesome

_Licenses and additional information can be found in the docs directory._

### Python ###
+ [beatbox](http://code.google.com/p/salesforce-beatbox/)
### Python
+ [beatbox](http://code.google.com/p/salesforce-beatbox/) (optional)

## Getting Started ##
## Getting Started
+ [Read about](https://github.com/solenopsis/Solenopsis/wiki/Solenopsis) Solenopsis
+ [Install](https://github.com/solenopsis/Solenopsis/wiki/Installation) Solenopsis
+ Get [Support](https://github.com/solenopsis/Solenopsis/blob/master/SUPPORT.md)

## Getting Started With v1.1##
## Getting Started With v1.1
+ [Configure](https://github.com/solenopsis/Solenopsis/wiki/1.1-Configuration) Solenopsis
+ [Use](https://github.com/solenopsis/Solenopsis/wiki/1.1-Usage---Python) Solenopsis
+ [Install](https://github.com/solenopsis/Solenopsis/wiki/1.1-Installation) Solenopsis
Expand Down
7 changes: 7 additions & 0 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Support

## Questions
If you have questions, the fastest way to get help is to reach out to us on [freenode](https://freenode.net/) in the [#solenopsis](https://webchat.freenode.net/?channels=#solenopsis) channel. Otherwise you can reach out to [pcon (@aelst)](https://twitter.com/aelst) on twitter or file an [issue](https://github.com/solenopsis/Solenopsis/issues) with the label "question"

## Bugs / Feature Requests
We're not perfect, (Ok [flossy](https://github.com/sfloess) may be) so things are bound to be broken. Feel free to file an [issue](https://github.com/solenopsis/Solenopsis/issues) with your problem or new feature and we'll get to it as soon as we can

0 comments on commit b1f6e4e

Please sign in to comment.