Browse Source

Updated documentation and prepared for initial release for v0.1.0

pull/1/head
Micah Halter 9 months ago
parent
commit
77a2fcd58a
Signed by: mehalter GPG Key ID: 4224A6EA9A8CAAA8
3 changed files with 22 additions and 6 deletions
  1. +5
    -0
      CHANGELOG.md
  2. +15
    -5
      README.md
  3. +2
    -1
      src/VirtualEnv.jl

+ 5
- 0
CHANGELOG.md View File

@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
## [Unreleased]
## [v0.1.0]
### Added
- Added custom prompts
@ -17,3 +19,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- Added `clear` option to clear environment directory if exists before creating
- Added ability to create multiple environments at once
- `venv` function to create self-contained julia environments
[Unreleased]: https://github.com/mehalter/VirtualEnv.jl/compare/v0.1.0...HEAD
[v0.1.0]: https://github.com/mehalter/VirtualEnv.jl/releases/tag/v0.0.1

+ 15
- 5
README.md View File

@ -2,18 +2,27 @@
Self contained virtual environments for Julia.
**Currently only officially supports Linux, but it should work on Mac OS X**
## Supported Shells
# Installation
- Bash
- ZSH
- Windows Command Prompt
### Upcoming
Current installation until ready to put on General.jl repository
- Fish
- CSH
- Powershell
# Installation
`~$ julia -e 'using Pkg; Pkg.add("https://git.mehalter.com/mehalter/VirtualEnv.jl.git")'`
`~$ julia -e 'using Pkg; Pkg.add("VirtualEnv")'`
# Usage
```
usage: venv(ENV_DIR, [ENV_DIR, ...]; [clear=(true|false)], [upgrade=(true|false)], [help=(true|false)])
usage: venv(ENV_DIR, [ENV_DIR, ...]; [clear=(true|false)], [upgrade=(true|false)],
[prompt=PROMPT], [help=(true|false)])
Creates virtual Julia environments in one or more target directories.
@ -26,6 +35,7 @@ optional arguments:
already exists, before environment creation. (Default: false)
upgrade=(true|false) Upgrade the environment directory to use this version
of Julia, assuming Julia has been upgraded in-place. (Default: false)
prompt=PROMPT Provides an alternative prompt prefix for this environment. (Default: ENV_DIR)
Once an environment has been created, you may wish to activate it,
e.g. by sourcing an activate script in its bin directory.


+ 2
- 1
src/VirtualEnv.jl View File

@ -44,7 +44,8 @@ Print usage of the venv function
"""
function usage()
print("""
usage: venv(ENV_DIR, [ENV_DIR, ...]; [clear=(true|false)], [upgrade=(true|false)], [prompt=PROMPT], [help=(true|false)])
usage: venv(ENV_DIR, [ENV_DIR, ...]; [clear=(true|false)], [upgrade=(true|false)],
[prompt=PROMPT], [help=(true|false)])
Creates virtual Julia environments in one or more target directories.


Loading…
Cancel
Save