Skip to content

Commit

Permalink
Add english README.md, fix russian README.ru.md
Browse files Browse the repository at this point in the history
  • Loading branch information
arikon committed Feb 18, 2012
1 parent 27347e1 commit 949b77b
Show file tree
Hide file tree
Showing 3 changed files with 95 additions and 18 deletions.
Empty file removed README
Empty file.
82 changes: 82 additions & 0 deletions README.md
@@ -0,0 +1,82 @@
# npm2debian
**npm2debian** is a command line tool to convert packages from npmjs.org repository to Debian packages.

## Overview

npm2debian [options] <package>

## Options

-h, --help : Help
-o OUTPUT, --output=OUTPUT : Output directory
--versioned : Build versioned debian package
--no-package-prefix : Do not add prefix to Debian package name
-m MAINTAINER,
--maintainer=MAINTAINER : Debian package maintainer name
-e EMAIL, --email=EMAIL : Debian package maintainer email
-p PACKAGEPREFIX,
--package-prefix=PACKAGEPREFIX : Debian package name prefix
-u DEBVERSION,
--debian-version=DEBVERSION : Debian package version
-b DEBBUILD,
--debian-build=DEBBUILD : Debian package build
-v, --version : Show version

## Environment

These environmanet variables are used during the packaging:

EMAIL="email@address"
DEBFULLNAME="Maintainer Full Name"

You will need the following Debian packages for the tool to work:

sudo apt-get install devscripts dh-make

You will need the following Debian packages to build debs:

sudo apt-get install debhelper fakeroot dpkg-dev

## Install

You have several options.

* Install globally from npm repository

`npm -g install npm2debian`

* Install locally

`npm install npm2debian`

* Install from sources

```
git clone https://github.com/arikon/npm2debian
cd npm2debian
npm install
```

## Usage examples

* Simple converting of `bem` package to `npm-bem`:

`npm2debian bem`

It will create `npm-bem-<version>` directory with source Debian package describing only one binary package `npm-bem`.

* To get Debian package with version in its name you should specify `--versioned` options:

`npm2debian --versioned bem`

It will create `npm-bem-<version>` directory with source Debian package describing two binary packages:

* `npm-bem`
* `npm-bem-<dashed-version>`, where `<dashed-version>` is a package version with dots replaced to dashes

* To build debs run:

```
cd npm-bem*
dpkg-buildpackage -rfakeroot
```
31 changes: 13 additions & 18 deletions README.ru.md
Expand Up @@ -10,17 +10,16 @@
-h, --help : показать подсказку для опций
-o OUTPUT, --output=OUTPUT : изменить директорию с результатом
--versioned : подготовить Debian пакет с указанием версии
--no-package-prefix : не укзаывать префикс для Debian пакетов
--no-package-prefix : не указывать префикс для Debian пакетов
-m MAINTAINER,
--maintainer=MAINTAINER : указать имя сопровождающего Debian пакет
-e EMAIL, --email=EMAIL : указать e-mail сопровождающего Debian пакет
-e EMAIL, --email=EMAIL : указать email сопровождающего Debian пакет
-p PACKAGEPREFIX,
--package-prefix=PACKAGEPREFIX : указать Debian префикс для имени пакета
-u DEBVERSION,
--debian-version=DEBVERSION : указать Debian версию для пакета
-b DEBBUILD,
--debian-build=DEBBUILD : указать Debian package build
--local : использовать собственные утилиты dh_make и debchange
-v, --version : показать версию инструмента

## Окружение
Expand All @@ -46,40 +45,36 @@

`npm -g install npm2debian`

* Локально для вашего пользователя
* Локальная установка

`npm install npm2debian`

* Или получить github версию из удаленного репозитория
* Установка из исходников

`git clone https://github.com/arikon/npm2debian`

затем перейти в рабочий каталог утилиты

`cd npm2debian`

и установить необходимые зависимости для работы

`npm install`
```
git clone https://github.com/arikon/npm2debian
cd npm2debian
npm install
```

## Примеры использования

* Конвертирование пакета `bem`:

`npm2debian bem`

В результате в директории `bem-<version>` будет создан сорцовый пакет для сборки одного бинарного пакета `npm-bem`.
В результате в директории `npm-bem-<version>` будет создан сорцовый пакет для сборки одного бинарного пакета `npm-bem`.

* Для конвертирования пакета с указанием версии, нужно указать опцию `--versioned`
* Для создания пакета с версией в имени нужно указать опцию `--versioned`:

`npm2debian --versioned bem`

В результате в директории `bem-<version>` будет создан сорцовый пакет для сборки двух бинарных пакетов
В результате в директории `npm-bem-<version>` будет создан сорцовый пакет для сборки двух бинарных пакетов:

* `npm-bem`
* `npm-bem-<dashed-version>`, где `<dashed-version>`, это версия, где вместо точек используются дефисы

* Сборка конвертированного Debian пакета
* Сборка конвертированного Debian пакета:

```
cd npm-bem*
Expand Down

0 comments on commit 949b77b

Please sign in to comment.