From 540ca09ddf38a37f6981269a72a3b365b48437df Mon Sep 17 00:00:00 2001 From: Unknown Date: Tue, 5 Nov 2013 17:12:58 -0500 Subject: [PATCH] Improved README --- README.md | 30 +++++++++++++++++++----------- cmd/cmd.go | 2 +- 2 files changed, 20 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 16b6a7559..307eac08b 100644 --- a/README.md +++ b/README.md @@ -5,65 +5,73 @@ gopm - Go Package Manager Gopm(Go Package Manager) is a Go package manage tool for search, install, update and share packages in Go. -**Attention** This application still in experiment, we'are working on new break version, you may use [old version](https://github.com/gpmgo/gopm/tree/v0.1.0) for now. +Current Version: **v0.5.1** # Requirement -Currently, gopm use soft symblink `ln -s` on Unix-like OS and `mklink -j` on Windows. -Make sure that you have the command. +- Go Development Environment >= 1.1. +- Command `ln -s` support on Mac OS and Unix-like systems. +- Command `mklink -j` support on Windows( **Windows Vista and later** ). -# Install +# Installation -You should install Go and Go tool before install gopm currently. +Because we do NOT offer binaries for now, so before you install the gopm, you should have already installed Go Development Environment with version 1.1 and later. ``` go get github.com/gpmgo/gopm ``` -This will install gopm on $GOPATH$/bin。Before using gopm, you should add this to $PATH. +The executable will be produced under `$GOPATH/bin` in your file system; for global use purpose, we recommand you to add this path into your `PATH` environment variable. # Features -* Don't need to install git, svn, hg etc. for installing packages. -* Package has version -* Every project has own GOPATH -* Put your Go project on anywhere you want +- No requirement for installing any version control system tool like `git`, `svn` or `hg` in order to download packages(although you have to install git for installing gopm though `go get` for now). +- Download, install or build your packages with specific revisions. +- When build program with `gopm build` or `gopm install`, everything just happen in its own GOPATH and do not bother anything you've done. +* Put your Go project on anywhere you want. -# Commands +# Quick start 1. Show the command help + ``` gopm help ``` 2. Show gopm version + ``` gopm version ``` 3. Get a package + ``` gopm get github.com/gpmgo/gopm ``` 4. Search a package + ``` gopm search gopm ``` 5. Build a project, the build's arguments are the same as go build. But it will check all the dependencies and dowload them. + ``` gopm build ``` 6. Run a go file + ``` gopm run main.go ``` 7. Install + ``` gopm install diff --git a/cmd/cmd.go b/cmd/cmd.go index 0740870f5..b87b4998e 100644 --- a/cmd/cmd.go +++ b/cmd/cmd.go @@ -20,7 +20,7 @@ import ( "strings" ) -const APP_VER = "0.5.1.1104" +const APP_VER = "0.5.1.1105" var ( AppPath string