Skip to content

Commit

Permalink
Documentation and animated GIF for overviewing OSS
Browse files Browse the repository at this point in the history
  • Loading branch information
Halleck45 committed Feb 14, 2015
1 parent 0649d04 commit 94353d9
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 5 deletions.
24 changes: 19 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,20 @@ Tool for managing Open Source assets.
## Why ?

Managing Open Source assets is a hard task in any project ; we often download awesome librairies, images or medias, but
where to keep trace of all theses files ? How can I manage Open Source licenses of my project ?
where to keep trace of all theses files ? How can I manage Open Source licenses of medias in my project ?

That's the problem oss try to resolve today.

![simple overview of oss](./doc/overview.gif)

## Installation

Download binary for your platform:

+ Linux Debian: [64bits](http://dl.bintray.com/halleck45/OSS/oss_linux_amd64), [32bits](http://dl.bintray.com/halleck45/OSS/oss_linux_386)
+ Windows: [64bits](http://dl.bintray.com/halleck45/OSS/oss_windows_amd64.exe), [32bits](http://dl.bintray.com/halleck45/OSS/oss_windows_386.exe)
+ [Others platforms](http://dl.bintray.com/halleck45/OSS/)

## Usage

On first run, please execute
Expand Down Expand Up @@ -36,9 +46,13 @@ MIT License. Copyright (c) Jean-François Lépine. See LICENSE for details.

## Contributing

You need to install:

+ [go](https://golang.org/)
+ [semver](https://github.com/flazz/semver/)
clone [email protected]:Halleck45/OSS.git
cd OSS
make init && make install
( ... your development ...)
make build

Remember to keep tests up to date (and, of course, to run them with `make test`)

Please never run `go build` manually. You should run `make build`.
Builds are hosted by [bintray](https://bintray.com). Today, only me (Halleck45) has permission to publish binaries.
Binary file added doc/overview.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 94353d9

Please sign in to comment.