summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJérémie Dimino <jeremie@dimino.org>2012-10-20 11:50:19 +0200
committerJérémie Dimino <jeremie@dimino.org>2012-10-20 11:50:19 +0200
commit2ac74087eca9d1dd4c4083ebead4af5c10b635dc (patch)
tree04028461bd0d880385583758e0063da4a88b434a
parentabdbcb1c5b3b27cfa99fa84abbc9cb35cc146fc8 (diff)
move to git
-rw-r--r--.gitignore6
-rw-r--r--.project1
-rw-r--r--CHANGES12
-rw-r--r--CHANGES.md15
-rw-r--r--README51
-rw-r--r--README.md55
-rw-r--r--_oasis6
-rw-r--r--boring4
-rwxr-xr-xdist38
-rwxr-xr-xdist.sh8
-rwxr-xr-xpredist.sh10
11 files changed, 117 insertions, 89 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..95fe78f
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,6 @@
+_build/
+/estring-*.tar.gz
+/setup.data
+/setup.log
+/setup.exe
+/setup-dev.exe
diff --git a/.project b/.project
deleted file mode 100644
index bce9acb..0000000
--- a/.project
+++ /dev/null
@@ -1 +0,0 @@
-estring
diff --git a/CHANGES b/CHANGES
deleted file mode 100644
index d497221..0000000
--- a/CHANGES
+++ /dev/null
@@ -1,12 +0,0 @@
-===== 1.3 (2012-09-23) =====
-
- * fix META generation
-
-===== 1.2 (2012-07-30) =====
-
- * update oasis files
-
-===== 1.1 (2011-03-05) =====
-
- * fix a bug in expansion of class expressions
- * use oasis
diff --git a/CHANGES.md b/CHANGES.md
new file mode 100644
index 0000000..e158034
--- /dev/null
+++ b/CHANGES.md
@@ -0,0 +1,15 @@
+1.3 (2012-09-23)
+----------------
+
+* fix `META` generation
+
+1.2 (2012-07-30)
+----------------
+
+* update oasis files
+
+1.1 (2011-03-05)
+----------------
+
+* fix a bug in expansion of class expressions
+* use oasis
diff --git a/README b/README
deleted file mode 100644
index 1285c2c..0000000
--- a/README
+++ /dev/null
@@ -1,51 +0,0 @@
- Extension for string literals
-
- Jeremie Dimino <jeremie@dimino.org>
- January 2009
-
-url: https://forge.ocamlcore.org/projects/estring/
-
-* What is estring
-
-Estring is a syntax extension which aims to make the use of custom
-string types more convenient.
-
-The idea is to replace code like that:
-
- (My_string.of_string "string literals")
-
-by that:
-
- m"string literals"
-
-* Requirement
-
-Estring needs ocaml >= 3.11.
-
-* Building and installation
-
-To build and install estring just type:
-
- $ make all
- $ make install
-
-This will install the estring package (ocamlfind is required).
-
-* How to use it
-
-Files in the "sample" directory show how to define string convertors.
-
-For the distribution of your project, you can either add a dependency
-to the estring package or embed it in your sources. Several instances
-of estring can work together so this will not break anything.
-
-* Development
-
-The last development version of estring can always be found in the
-darcs repository hosted at darcs.ocamlcore.org:
-
- $ darcs get http://darcs.ocamlcore.org/repos/estring/estring
-
-local variables:
-mode: outline
-end:
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..108a2de
--- /dev/null
+++ b/README.md
@@ -0,0 +1,55 @@
+estring - extension for string literals
+=======================================
+
+Estring is a syntax extension which aims to make the use of custom
+string types more convenient.
+
+The idea is to replace this kind of code:
+
+ (My_string.of_string "string literals")
+
+by:
+
+ m"string literals"
+
+Dependencies
+------------
+
+* [OCaml](http://caml.inria.fr/ocaml/) (>= 3.11)
+* [findlib](http://projects.camlcity.org/projects/findlib.html)
+
+For building the development version, you also need to install
+[oasis](http://oasis.forge.ocamlcore.org/) (>= 0.3.0).
+
+Installation
+------------
+
+To build and install estring:
+
+ $ ./configure
+ $ make
+ $ make install
+
+### Documentation _(optional)_
+
+To build the documentation:
+
+ $ make doc
+
+It will then be installed by `make install`.
+
+### Tests _(optionnal)_
+
+To build and execute tests:
+
+ $ ./configure --enable-tests
+ $ make test
+
+Usage
+-----
+
+Files in the "sample" directory show how to define string convertors.
+
+For the distribution of your project, you can either add a dependency
+to the estring package or embed it in your sources. Several instances
+of estring can work together so this will not break anything.
diff --git a/_oasis b/_oasis
index 04e02ec..a165be6 100644
--- a/_oasis
+++ b/_oasis
@@ -61,6 +61,6 @@ Document "estring-api"
# +-------------------------------------------------------------------+
SourceRepository head
- Type: darcs
- Location: http://darcs.ocamlcore.org/repos/estring
- Browser: http://darcs.ocamlcore.org/cgi-bin/darcsweb.cgi?r=estring;a=summary
+ Type: git
+ Location: https://github.com/diml/estring.git
+ Browser: https://github.com/diml/estring
diff --git a/boring b/boring
deleted file mode 100644
index 1250f58..0000000
--- a/boring
+++ /dev/null
@@ -1,4 +0,0 @@
-(^|/)_build($|/)
-^estring-.*\.tar\.gz$
-^setup\.data$
-^setup\.log$
diff --git a/dist b/dist
new file mode 100755
index 0000000..ae5efa6
--- /dev/null
+++ b/dist
@@ -0,0 +1,38 @@
+#!/bin/bash
+#
+# dist
+# ----
+# Copyright : (c) 2012, Jeremie Dimino <jeremie@dimino.org>
+# Licence : BSD3
+#
+# Script to build the release
+
+set -e
+
+# Extract project parameters from _oasis
+NAME=`oasis query Name 2> /dev/null`
+VERSION=`oasis query Version 2> /dev/null`
+PREFIX=$NAME-$VERSION
+ARCHIVE=$(pwd)/$PREFIX.tar.gz
+
+# Temporary directory
+DIR=$(mktemp -t -d dist.XXXXXXXXXX)
+trap "rm -rf $DIR" EXIT
+
+# Copy files into the temporary directory
+git archive --format=tar --prefix $NAME-$VERSION/ HEAD | tar xf - -C $DIR
+
+cd $DIR/$PREFIX
+
+# Generate files
+oasis setup
+
+# Set release mode in the Makefile
+sed -i 's/^SETUP := setup-dev.exe.*/SETUP := setup.exe/' Makefile
+
+# Remove this script
+rm -f dist
+
+# Create the archive
+cd ..
+tar czf $ARCHIVE $PREFIX
diff --git a/dist.sh b/dist.sh
deleted file mode 100755
index 8363cf5..0000000
--- a/dist.sh
+++ /dev/null
@@ -1,8 +0,0 @@
-#!/bin/sh
-
-NAME=`oasis query Name 2> /dev/null`
-VERSION=`oasis query Version 2> /dev/null`
-DARCS_REPO=`pwd`
-export DARCS_REPO
-
-exec darcs dist --dist-name $NAME-$VERSION
diff --git a/predist.sh b/predist.sh
deleted file mode 100755
index f0cc83b..0000000
--- a/predist.sh
+++ /dev/null
@@ -1,10 +0,0 @@
-#!/bin/sh
-
-# Generate CHANGES.darcs
-[ -d "$DARCS_REPO" ] && darcs changes --repodir "$DARCS_REPO" > CHANGES.darcs
-
-# Add oasis stuff
-oasis setup
-
-# Cleanup
-rm -f dist.sh predist.sh boring