Commit 0d621f586575c1db836d59ceaef850eaac922be3 - Funicular

Bump version number in README, and drop Mercurial support. Chris Pressey 2 years ago

4 changed file(s) with 69 addition(s) and 89 deletion(s). Raw diff Collapse all Expand all

-16

~~.hgignore~~ less more

0		syntax: glob
1
2		*.iso
3		*.img
4		*.gz
5		*.rom
6		*.adf
7		*.dms
8		*.d64
9		distfiles
10		distrepos
11		staging_area
12		dh0
13		device8
14		.uaerc
15		vicerc

-4

~~.hgtags~~ less more

0		92abce3aded8192321e313cd7ed48a9b3583b198 0.1
1		ba25e6621afeee63737429900c27997ee1e22d42 0.1-2015.0105
2		74f53ac7f015ba228c59de094201c452a3d15126 0.2
3		de4b41c0071b4c632fc1273adc982bd158706531 0.3

-69

~~README.markdown~~ less more

0		Funicular
1		=========
2
3		Version 0.5. Work-in-progress. Subject to change in backwards-incompatible ways.
4
5		Funicular is a system that semi-automates the creation of computing
6		environments on eclectic architectures.
7
8		"Semi-automate" means it automates what it can, and provides repeatable
9		instructions for you to follow for what it can't.
10
11		"Computing environment" could mean a "development environment", i.e.
12		a system in which you can build (and perhaps even write) software,
13		populated with interpreters and compilers, debuggers, text editors,
14		and the like. Or it could mean any other environment that could be
15		set up on a computer system.
16
17		"Eclectic architectures" is not terribly-well defined, but it includes
18		retrocomputing and esoteric architectures. Basically, if you've got an
19		emulator for it, and installation images for it, you might be able to
20		install and outfit and run a system for it, using Funicular.
21
22		TL;DR it's kind of like a Vagrant, but instead of provisioning VMs, it
23		provisions emulators.
24
25		It currently supports:
26
27		* i386 running NetBSD under QEMU
28		* i386 running FreeDOS under QEMU
29		* Amiga 500 (etc) running AmigaDOS under E-UAE
30		* Commodore 64 with a 1541 floppy drive under VICE
31		* VIC-20 with a 1541 floppy drive under VICE
32		* Apple //e running AppleDOS under Linapple
33
34		Funicular unifies and replaces the older, discrete, ad-hoc projects
35		NetBSD-Gondola, FreeDOS-Gondola, and Amiga-Gondola, which are now deprecated.
36
37		Quick Start
38		-----------
39
40		* `cd` into a directory that has a `Funicularfile`.
41		* Run `funicular init system`.
42		* Acquire the appropriate install image.
43		* Run `funicular install`.
44		* Run `funicular init setup`.
45		* Run `funicular setup`.
46		* You now have a configured Funicular. Run `funicular start` to use it.
47
48		Documentation
49		-------------
50
51		The reference implementation of the `funicular` tool is written in Bourne
52		shell. A `Funicularfile` is also written in Bourne shell, but it mostly
53		contains configuration, not functionality.
54
55		You can look at the settings in the example Funicularfiles in `eg/` and
56		look them up in the source code in `script/` to divine what they mean.
57
58		Because the entire thing was recently rewritten (converting it from
59		Lua to Bourne shell), there really isn't any further documentation right
60		now except for [this out-of-date set of notes](doc/Notes.md).
61
62		License
63		-------
64
65		The contents of this repository are in the public domain. This, of course,
66		applies only to the contents of this repository, and not to the contents of
67		any particular Funicular you build with with this software. See the file
68		`UNLICENSE` in this directory for more information.

+69

-0

README.md less more

	0	Funicular
	1	=========
	2
	3	Version 0.6. Work-in-progress. Subject to change in backwards-incompatible ways.
	4
	5	Funicular is a system that semi-automates the creation of computing
	6	environments on eclectic architectures.
	7
	8	"Semi-automate" means it automates what it can, and provides repeatable
	9	instructions for you to follow for what it can't.
	10
	11	"Computing environment" could mean a "development environment", i.e.
	12	a system in which you can build (and perhaps even write) software,
	13	populated with interpreters and compilers, debuggers, text editors,
	14	and the like. Or it could mean any other environment that could be
	15	set up on a computer system.
	16
	17	"Eclectic architectures" is not terribly-well defined, but it includes
	18	retrocomputing and esoteric architectures. Basically, if you've got an
	19	emulator for it, and installation images for it, you might be able to
	20	install and outfit and run a system for it, using Funicular.
	21
	22	TL;DR it's kind of like a Vagrant, but instead of provisioning VMs, it
	23	provisions emulators.
	24
	25	It currently supports:
	26
	27	* i386 running NetBSD under QEMU
	28	* i386 running FreeDOS under QEMU
	29	* Amiga 500 (etc) running AmigaDOS under E-UAE
	30	* Commodore 64 with a 1541 floppy drive under VICE
	31	* VIC-20 with a 1541 floppy drive under VICE
	32	* Apple //e running AppleDOS under Linapple
	33
	34	Funicular unifies and replaces the older, discrete, ad-hoc projects
	35	NetBSD-Gondola, FreeDOS-Gondola, and Amiga-Gondola, which are now deprecated.
	36
	37	Quick Start
	38	-----------
	39
	40	* `cd` into a directory that has a `Funicularfile`.
	41	* Run `funicular init system`.
	42	* Acquire the appropriate install image.
	43	* Run `funicular install`.
	44	* Run `funicular init setup`.
	45	* Run `funicular setup`.
	46	* You now have a configured Funicular. Run `funicular start` to use it.
	47
	48	Documentation
	49	-------------
	50
	51	The reference implementation of the `funicular` tool is written in Bourne
	52	shell. A `Funicularfile` is also written in Bourne shell, but it mostly
	53	contains configuration, not functionality.
	54
	55	You can look at the settings in the example Funicularfiles in `eg/` and
	56	look them up in the source code in `script/` to divine what they mean.
	57
	58	Because the entire thing was recently rewritten (converting it from
	59	Lua to Bourne shell), there really isn't any further documentation right
	60	now except for [this out-of-date set of notes](doc/Notes.md).
	61
	62	License
	63	-------
	64
	65	The contents of this repository are in the public domain. This, of course,
	66	applies only to the contents of this repository, and not to the contents of
	67	any particular Funicular you build with with this software. See the file
	68	`UNLICENSE` in this directory for more information.