Remove install.txt and readme.txt (#9521)
* Remove install.txt and readme.txt * Refactor tests that use readme.txt * Tests open own source code
This commit is contained in:
parent
95a60dc780
commit
a68a4bfaf2
10 changed files with 10 additions and 115 deletions
|
|
@ -49,7 +49,7 @@ Start: "doc/html/overview.html"
|
||||||
|
|
||||||
|
|
||||||
[Other]
|
[Other]
|
||||||
Files: "readme.txt;copying.txt;install.txt"
|
Files: "copying.txt"
|
||||||
Files: "makefile"
|
Files: "makefile"
|
||||||
Files: "koch.nim"
|
Files: "koch.nim"
|
||||||
Files: "install_nimble.nims"
|
Files: "install_nimble.nims"
|
||||||
|
|
|
||||||
88
install.txt
88
install.txt
|
|
@ -1,88 +0,0 @@
|
||||||
Installation
|
|
||||||
============
|
|
||||||
|
|
||||||
Installation on Linux/UNIX
|
|
||||||
--------------------------
|
|
||||||
|
|
||||||
The GNU C Compiler is fully supported, other compilers may work. The C compiler
|
|
||||||
should be in your ``$PATH`` (most likely the case). Note that some few Linux
|
|
||||||
distributions do not ship with a GCC compiler preinstalled - then you have to
|
|
||||||
install it.
|
|
||||||
|
|
||||||
Install Nim by downloading the appropriate ``.tar.xz`` file and extracting it
|
|
||||||
to a directory of your choice. The Nim Compiler will stay in this
|
|
||||||
directory (unless you copy it somewhere else). The compiler does not need
|
|
||||||
write access to its directory, so copying the nim folder to ``/opt``
|
|
||||||
works.
|
|
||||||
|
|
||||||
Then run the following command::
|
|
||||||
|
|
||||||
sh build.sh
|
|
||||||
|
|
||||||
Unlike other software, Nim does not distribute its files over the whole file
|
|
||||||
hierarchy. This has the advantage that you can deinstall it by just deleting
|
|
||||||
its folder. The disadvantage is that you have to add it to your ``PATH``
|
|
||||||
manually. An alternative is to create a symbolic link in ``/usr/bin``::
|
|
||||||
|
|
||||||
[sudo] ln -s $your_install_dir/bin/nim /usr/bin/nim
|
|
||||||
|
|
||||||
There are also ``install.sh`` and ``deinstall.sh`` scripts for distributing
|
|
||||||
the files over the UNIX hierarchy. However, updating your Nim installation
|
|
||||||
is more cumbersome then.
|
|
||||||
|
|
||||||
To complete the installation you should also build Nim's tools like
|
|
||||||
``nimsuggest``, ``nimble`` or ``nimgrep`` via::
|
|
||||||
|
|
||||||
nim c koch
|
|
||||||
koch tools
|
|
||||||
|
|
||||||
Note that these tools should also end up in your ``PATH`` so adding
|
|
||||||
``$your_install_dir/bin/nim`` to your ``PATH`` is preferred over the symlink
|
|
||||||
solution.
|
|
||||||
|
|
||||||
|
|
||||||
Installation on the Macintosh
|
|
||||||
-----------------------------
|
|
||||||
|
|
||||||
Only MacOS X is supported.
|
|
||||||
Since MacOS X is UNIX based too, it works like the installation on Linux.
|
|
||||||
However, for unknown reasons the symbolic link method does not work on MacOS X.
|
|
||||||
You need to install Apple's developer's tools for the GNU Compiler Collection
|
|
||||||
or clang.
|
|
||||||
|
|
||||||
|
|
||||||
Installation on Windows
|
|
||||||
-----------------------
|
|
||||||
|
|
||||||
Install Nim by downloading and unzipping the ``nim_$version.zip`` file.
|
|
||||||
Run ``finish.exe`` to detect and setup your MingW environment.
|
|
||||||
|
|
||||||
Currently, the following C compilers are supported under Windows:
|
|
||||||
|
|
||||||
- | Microsoft's Visual C++
|
|
||||||
| http://msdn.microsoft.com/visualc
|
|
||||||
| (You need the SDK too - but not the full one: Only
|
|
||||||
the win32api header files and import libraries are essential.)
|
|
||||||
- | Gnu C Compiler (the mingw version; the cygwin version has not been tested!)
|
|
||||||
| http://www.mingw.org/download.shtml
|
|
||||||
- | LLVM with Clang or GNU C/C++ frontend
|
|
||||||
| http://llvm.org/releases/download.html
|
|
||||||
|
|
||||||
However, most testing is done with GCC.
|
|
||||||
|
|
||||||
Bootstrapping from GitHub
|
|
||||||
-------------------------
|
|
||||||
|
|
||||||
Take a look at the readme file on github `here <https://github.com/nim-lang/Nim#readme>`_
|
|
||||||
for instructions.
|
|
||||||
|
|
||||||
|
|
||||||
Installation of Nimble
|
|
||||||
----------------------
|
|
||||||
|
|
||||||
Nimble is Nim's package manager. For the source based installations where you
|
|
||||||
added Nim's ``bin`` directory to your ``$PATH`` the easiest way of installing
|
|
||||||
Nimble is via::
|
|
||||||
|
|
||||||
nim c koch
|
|
||||||
koch nimble
|
|
||||||
18
readme.txt
18
readme.txt
|
|
@ -1,18 +0,0 @@
|
||||||
This package contains the Nim compiler, Nim's stdlib, tools and
|
|
||||||
documentation.
|
|
||||||
|
|
||||||
Nim is a compiled, garbage-collected systems programming language which has
|
|
||||||
an excellent productivity/performance ratio. Nim's design focuses on
|
|
||||||
efficiency, expressiveness, elegance (in the order of priority).
|
|
||||||
|
|
||||||
Read install.txt for instructions of how to build and install it.
|
|
||||||
|
|
||||||
The compiler and the standard library are licensed under the MIT license,
|
|
||||||
except for some modules where the documentation suggests otherwise. This means
|
|
||||||
that you can use any license for your own programs developed with Nim,
|
|
||||||
allowing you to create commercial applications.
|
|
||||||
|
|
||||||
Read copying.txt for more details.
|
|
||||||
|
|
||||||
Copyright (c) 2006-2018 Andreas Rumpf.
|
|
||||||
All rights reserved.
|
|
||||||
1
tests/dummy.txt
Normal file
1
tests/dummy.txt
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
Just a simple text for test
|
||||||
|
|
@ -5,7 +5,7 @@ var
|
||||||
inp: File
|
inp: File
|
||||||
line: string
|
line: string
|
||||||
|
|
||||||
if open(inp, "readme.txt"):
|
if open(inp, "tests/misc/treadln.nim"):
|
||||||
while not endOfFile(inp):
|
while not endOfFile(inp):
|
||||||
line = readLine(inp)
|
line = readLine(inp)
|
||||||
echo("#" & line & "#")
|
echo("#" & line & "#")
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
import memfiles
|
import memfiles
|
||||||
var inp = memfiles.open("readme.txt")
|
var inp = memfiles.open("tests/stdlib/tmemlines.nim")
|
||||||
for line in lines(inp):
|
for line in lines(inp):
|
||||||
echo("#" & line & "#")
|
echo("#" & line & "#")
|
||||||
close(inp)
|
close(inp)
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
import memfiles
|
import memfiles
|
||||||
var inp = memfiles.open("readme.txt")
|
var inp = memfiles.open("tests/stdlib/tmemlinesBuf.nim")
|
||||||
var buffer: TaintedString = ""
|
var buffer: TaintedString = ""
|
||||||
for line in lines(inp, buffer):
|
for line in lines(inp, buffer):
|
||||||
echo("#" & line & "#")
|
echo("#" & line & "#")
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
import memfiles
|
import memfiles
|
||||||
var inp = memfiles.open("readme.txt")
|
var inp = memfiles.open("tests/stdlib/tmemslices.nim")
|
||||||
for mem in memSlices(inp):
|
for mem in memSlices(inp):
|
||||||
if mem.size > 3:
|
if mem.size > 3:
|
||||||
echo("#" & $mem & "#")
|
echo("#" & $mem & "#")
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
discard """
|
discard """
|
||||||
outputsub: "All rights reserved."
|
outputsub: "Just a simple text for test"
|
||||||
"""
|
"""
|
||||||
|
|
||||||
type
|
type
|
||||||
|
|
@ -28,7 +28,7 @@ proc consume() {.thread.} =
|
||||||
proc produce() {.thread.} =
|
proc produce() {.thread.} =
|
||||||
prodId = getThreadId()
|
prodId = getThreadId()
|
||||||
var m: TMsg
|
var m: TMsg
|
||||||
var input = open("readme.txt")
|
var input = open("tests/dummy.txt")
|
||||||
var line = ""
|
var line = ""
|
||||||
while input.readLine(line):
|
while input.readLine(line):
|
||||||
m.data = line
|
m.data = line
|
||||||
|
|
|
||||||
|
|
@ -4,8 +4,8 @@ template getScriptDir(): string =
|
||||||
parentDir(instantiationInfo(-1, true).filename)
|
parentDir(instantiationInfo(-1, true).filename)
|
||||||
|
|
||||||
const
|
const
|
||||||
relRes = slurp"../../readme.txt"
|
relRes = slurp"./tslurp.nim"
|
||||||
absRes = slurp(parentDir(parentDir(getScriptDir())) / "readme.txt")
|
absRes = slurp(getScriptDir() / "tslurp.nim")
|
||||||
|
|
||||||
echo relRes
|
echo relRes
|
||||||
echo absRes
|
echo absRes
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue