Browse Source

Improved README

pull/103/head
Unknown 11 years ago
parent
commit
540ca09ddf
  1. 30
      README.md
  2. 2
      cmd/cmd.go

30
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. 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 # Requirement
Currently, gopm use soft symblink `ln -s` on Unix-like OS and `mklink -j` on Windows. - Go Development Environment >= 1.1.
Make sure that you have the command. - 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 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 # Features
* Don't need to install git, svn, hg etc. for installing packages. - 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).
* Package has version - Download, install or build your packages with specific revisions.
* Every project has own GOPATH - 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 * Put your Go project on anywhere you want.
# Commands # Quick start
1. Show the command help 1. Show the command help
``` ```
gopm help gopm help
``` ```
2. Show gopm version 2. Show gopm version
``` ```
gopm version gopm version
``` ```
3. Get a package 3. Get a package
``` ```
gopm get github.com/gpmgo/gopm gopm get github.com/gpmgo/gopm
``` ```
4. Search a package 4. Search a package
``` ```
gopm search gopm 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. 5. Build a project, the build's arguments are the same as go build. But it will check all the dependencies and dowload them.
``` ```
<change to project directory> <change to project directory>
gopm build gopm build
``` ```
6. Run a go file 6. Run a go file
``` ```
<change to project directory> <change to project directory>
gopm run main.go gopm run main.go
``` ```
7. Install 7. Install
``` ```
<change to project directory> <change to project directory>
gopm install gopm install

2
cmd/cmd.go

@ -20,7 +20,7 @@ import (
"strings" "strings"
) )
const APP_VER = "0.5.1.1104" const APP_VER = "0.5.1.1105"
var ( var (
AppPath string AppPath string

Loading…
Cancel
Save