From 6ddfdb8c77b1c16dc6097e4e2a543ad77c0bb647 Mon Sep 17 00:00:00 2001 From: Dominik Picheta Date: Sat, 11 Oct 2014 22:51:25 +0100 Subject: [PATCH] More renames in readme. --- nimble.nimble | 6 +- readme.markdown | 142 ++++++++++++++++++++++++------------------------ 2 files changed, 74 insertions(+), 74 deletions(-) diff --git a/nimble.nimble b/nimble.nimble index 359682e..949f9c2 100644 --- a/nimble.nimble +++ b/nimble.nimble @@ -1,11 +1,11 @@ [Package] -name = "babel" +name = "nimble" version = "0.4.0" author = "Dominik Picheta" -description = "Nimrod package manager." +description = "Nim package manager." license = "BSD" -bin = "babel" +bin = "nimble" srcDir = "src" [Deps] diff --git a/readme.markdown b/readme.markdown index 015a7fe..0dcb187 100644 --- a/readme.markdown +++ b/readme.markdown @@ -1,17 +1,17 @@ -# Babel +# Nimble -Babel is a *beta*-grade *package manager* for the [Nimrod programming +Nimble is a *beta*-grade *package manager* for the [Nimrod programming language](http://nimrod-lang.org). -**Note:** This readme explains how to install and use babel. It does not -explain how to create babel packages. Take a look at the +**Note:** This readme explains how to install and use nimble. It does not +explain how to create nimble packages. Take a look at the [developers.markdown file](developers.markdown) for information regarding package creation. ## Installation You will need version 0.9.4 (or better) of the [Nimrod -compiler](http://nimrod-lang.org/download.html). To run babel you will need to +compiler](http://nimrod-lang.org/download.html). To run nimble you will need to have installed some of the tools it depends on to check out source code. For instance, if a package is hosted on [Github](https://github.com) you require to have [git](http://www.git-scm.com) installed and added to your environment @@ -21,88 +21,88 @@ DLLs](https://www.openssl.org) for secure network connections. ### Unix -On Unix operating systems Babel can be compiled and installed with two simple +On Unix operating systems Nimble can be compiled and installed with two simple commands. After successfully grabbing the latest Nimrod compiler simply execute -the following commands to clone babel, compile it and then install it. +the following commands to clone nimble, compile it and then install it. - git clone https://github.com/nimrod-code/babel.git - cd babel - nimrod c -r src/babel install + git clone https://github.com/nimrod-code/nimble.git + cd nimble + nimrod c -r src/nimble install -After these steps babel should be compiled and installed. You should then add -``~/.babel/bin`` to your ``$PATH``. Updating babel can then be done by -executing ``babel install babel``. +After these steps nimble should be compiled and installed. You should then add +``~/.nimble/bin`` to your ``$PATH``. Updating nimble can then be done by +executing ``nimble install nimble``. ### Windows -On Windows installing Babel is slightly more complex: +On Windows installing Nimble is slightly more complex: - git clone https://github.com/nimrod-code/babel.git - cd babel - nimrod c src\babel - cp src\babel.exe src\babel1.exe - src\babel1.exe install + git clone https://github.com/nimrod-code/nimble.git + cd nimble + nimrod c src\nimble + cp src\nimble.exe src\nimble1.exe + src\nimble1.exe install This is required because Windows will lock the process which is being run. -## Babel's folder structure and packages +## Nimble's folder structure and packages -Babel stores everything that has been installed in ``~/.babel`` on Unix systems -and in your ``$home/.babel`` on Windows. Libraries are stored in -``$babelDir/pkgs``, and binaries are stored in ``$babelDir/bin``. Most Babel +Nimble stores everything that has been installed in ``~/.nimble`` on Unix systems +and in your ``$home/.nimble`` on Windows. Libraries are stored in +``$nimbleDir/pkgs``, and binaries are stored in ``$nimbleDir/bin``. Most Nimble packages will provide ``.nim`` files and some documentation. The Nimrod -compiler is aware of Babel and will automatically find the modules so you can +compiler is aware of Nimble and will automatically find the modules so you can ``import modulename`` and have that working without additional setup. -However, some Babel packages can provide additional tools or commands. If you -don't add their location (``$babelDir/bin``) to your ``$PATH`` they will not +However, some Nimble packages can provide additional tools or commands. If you +don't add their location (``$nimbleDir/bin``) to your ``$PATH`` they will not work properly and you won't be able to run them. -## Babel usage +## Nimble usage -Once you have Babel installed on your system you can run the ``babel`` command +Once you have Nimble installed on your system you can run the ``nimble`` command to obtain a list of available commands. -### babel update +### nimble update -The ``update`` command is used to fetch and update the list of Babel packages +The ``update`` command is used to fetch and update the list of Nimble packages (see below). There is no automatic update mechanism, so you need to run this -yourself if you need to *refresh* your local list of known available Babel +yourself if you need to *refresh* your local list of known available Nimble packages. Example: - $ babel update + $ nimble update Downloading package list from https://.../packages.json Done. -Some commands may remind you to run ``babel update`` or will run it for you if +Some commands may remind you to run ``nimble update`` or will run it for you if they fail. You can also optionally supply this command with a URL if you would like to use a third-party package list. -### babel install +### nimble install The ``install`` command will download and install a package. You need to pass the name of the package (or packages) you want to install. If any of the -packages depend on other Babel packages Babel will also install them. +packages depend on other Nimble packages Nimble will also install them. Example: - $ babel install nake - Downloading nake into /tmp/babel/nake... + $ nimble install nake + Downloading nake into /tmp/nimble/nake... Executing git... ... nake installed successfully -Babel always fetches and installs the latest version of a package. Note that +Nimble always fetches and installs the latest version of a package. Note that latest version is defined as the latest tagged version in the git (or hg) repository, if the package has no tagged versions then the latest commit in the remote repository will be installed. If you already have that version installed -Babel will ask you whether you wish it to overwrite your local copy. +Nimble will ask you whether you wish it to overwrite your local copy. -You can force Babel to download the latest commit from the package's repo, for +You can force Nimble to download the latest commit from the package's repo, for example: - $ babel install nimgame@#head + $ nimble install nimgame@#head This is of course git specific, for hg use ``tip`` instead of ``head``. A branch, tag, or commit hash may also be specified in the place of ``head``. @@ -110,20 +110,20 @@ branch, tag, or commit hash may also be specified in the place of ``head``. Instead of specifying a VCS branch you may also specify a version range, for example: - $ babel install nimgame@"> 0.5" + $ nimble install nimgame@"> 0.5" In this case a version which is greater than ``0.5`` will be installed. -If you don't specify a parameter and there is a ``package.babel`` file in your -current working directory then Babel will install the package residing in +If you don't specify a parameter and there is a ``package.nimble`` file in your +current working directory then Nimble will install the package residing in the current working directory. This can be useful for developers who are testing -locally their ``.babel`` files before submitting them to the official package +locally their ``.nimble`` files before submitting them to the official package list. See [developers.markdown](developers.markdown) for more info on this. -A URL to a repository can also be specified, Babel will automatically detect +A URL to a repository can also be specified, Nimble will automatically detect the type of the repository that the url points to and install it. -### babel uninstall +### nimble uninstall The ``uninstall`` command will remove an installed package. Attempting to remove a package which other packages depend on is disallowed and will result in an @@ -131,31 +131,31 @@ error. You must currently manually remove the reverse dependencies first. Similar to the ``install`` command you can specify a version range, for example: - $ babel uninstall nimgame@0.5 + $ nimble uninstall nimgame@0.5 -### babel build +### nimble build The ``build`` command is mostly used by developers who want to test building -their ``.babel`` package. The ``install`` command calls ``build`` implicitly, +their ``.nimble`` package. The ``install`` command calls ``build`` implicitly, so there is rarely any reason to use this command directly. -### babel list +### nimble list The ``list`` command will display the known list of packages available for -Babel. An optional ``--ver`` parameter can be specified to tell Babel to +Nimble. An optional ``--ver`` parameter can be specified to tell Nimble to query remote git repositories for the list of versions of the packages and to then print the versions. Please note however that this can be slow as each package must be queried separately. -### babel search +### nimble search If you don't want to go through the whole output of the ``list`` command you can use the ``search`` command specifying as parameters the package name and/or -tags you want to filter. Babel will look into the known list of available +tags you want to filter. Nimble will look into the known list of available packages and display only those that match the specified keywords (which can be substrings). Example: - $ babel search math + $ nimble search math linagl: url: https://bitbucket.org/BitPuffin/linagl (hg) tags: library, opengl, math, game @@ -170,32 +170,32 @@ substrings). Example: Searches are case insensitive. -An optional ``--ver`` parameter can be specified to tell Babel to +An optional ``--ver`` parameter can be specified to tell Nimble to query remote git repositories for the list of versions of the packages and to then print the versions. Please note however that this can be slow as each package must be queried separately. -### babel path +### nimble path -The babel ``path`` command will show the absolute path to the installed +The nimble ``path`` command will show the absolute path to the installed packages matching the specified parameters. Since there can be many versions of the same package installed, the ``path`` command will always show the latest version. Example: - $ babel path argument_parser - /home/user/.babel/pkgs/argument_parser-0.1.2 + $ nimble path argument_parser + /home/user/.nimble/pkgs/argument_parser-0.1.2 Under Unix you can use backticks to quickly access the directory of a package, which can be useful to read the bundled documentation. Example: $ pwd /usr/local/bin - $ cd `babel path argument_parser` + $ cd `nimble path argument_parser` $ less README.md ## Configuration -At startup Babel will attempt to read ``$AppDir/babel/babel.ini``, +At startup Nimble will attempt to read ``$AppDir/nimble/nimble.ini``, where ``$AppDir`` is ``~/.config/`` on Linux and ``C:\Users\\AppData\Roaming\`` on Windows. @@ -203,29 +203,29 @@ The format of this file corresponds to the ini format with some Nimrod enhancements. For example: ```ini -babelDir = r"C:\Babel\" +nimbleDir = r"C:\Nimble\" ``` You can currently configure the following in this file: -* ``babelDir`` - The directory which babel uses for package installation. - **Default:** ``~/.babel/`` +* ``nimbleDir`` - The directory which nimble uses for package installation. + **Default:** ``~/.nimble/`` ## Packages -Babel works on git repositories as its primary source of packages. Its list of +Nimble works on git repositories as its primary source of packages. Its list of packages is stored in a JSON file which is freely accessible in the [nimrod-code/packages repository](https://github.com/nimrod-code/packages). -This JSON file provides babel with the required Git URL to clone the package +This JSON file provides nimble with the required Git URL to clone the package and install it. Installation and build instructions are contained inside a -ini-style file with the ``.babel`` file extension. The babel file shares the +ini-style file with the ``.nimble`` file extension. The nimble file shares the package's name. ## Contribution If you would like to help, feel free to fork and make any additions you see fit and then send a pull request. If you are a developer willing to produce new -Babel packages please read the [developers.markdown file](developers.markdown) +Nimble packages please read the [developers.markdown file](developers.markdown) for detailed information. If you have any questions about the project you can ask me directly on github, @@ -234,7 +234,7 @@ the #nimrod channel. ## About -Babel has been written by [Dominik Picheta](http://picheta.me/) with help from +Nimble has been written by [Dominik Picheta](http://picheta.me/) with help from a number of -[contributors](https://github.com/nimrod-code/babel/graphs/contributors). +[contributors](https://github.com/nimrod-code/nimble/graphs/contributors). It is licensed under the BSD license (Look at license.txt for more info).