1
0
Fork 0
mirror of git://git.code.sf.net/p/cdesktopenv/code synced 2025-03-09 15:50:02 +00:00

README.md: update and rename top level README to README.md

This commit is contained in:
Jon Trulson 2021-07-03 20:07:43 -06:00
parent 39d3a67701
commit 2bc3052313
3 changed files with 98 additions and 63 deletions

View file

@ -1,5 +1,5 @@
docsdir = $(CDE_INSTALLATION_TOP)
docs_DATA = CONTRIBUTORS COPYING copyright HISTORY README
docs_DATA = CONTRIBUTORS COPYING copyright HISTORY README.md
MAINTAINERCLEANFILES = Makefile.in \
configure libtool \

View file

@ -1,62 +0,0 @@
*************************************
The Common Desktop Environment is released under the terms of the LGPL
V2 license. You may reuse and redistribute this code under the terms
of this license. See the COPYING file for details.
*************************************
Purpose of this release:
This release of CDE under a new opensource license is numbered
starting at version 2.2.0.
************************************
Downloading this release:
CDE may be downloaded in source form from the Common Desktop
Environment website:
http://sourceforge.net/projects/cdesktopenv/
Or via git:
git clone git://git.code.sf.net/p/cdesktopenv/code cdesktopenv-code
The git repository will always be more up to date than the
downloadable tarballs we make available, so if you have problems,
please try the latest version from git master.
************************************
Installing this release:
Complete build and installation instructions can be found on the CDE
wiki:
http://sourceforge.net/p/cdesktopenv/wiki/Home/
Please go there and read the appropriate section(s) for your OS (Linux
or FreeBSD/OpenBSD/NetBSD currently). There are a variety of
dependencies that must be met, as well as specific set up steps
required to build.
Do not expect to just type 'make' and have it actually work without
meeting the prerequisites and following the correct steps as spelled
out on the wiki. :)
There are also a lot of other documents and information there that you
might find useful.
************************************
Support:
You can join the development mailing list here:
https://lists.sourceforge.net/lists/listinfo/cdesktopenv-devel
There is a CDE IRC channel on chat.freenode.net, channel #cde
Bug reports and patches encouraged.

97
cde/README.md Normal file
View file

@ -0,0 +1,97 @@
CDE - The Common Destop Environment
===
In 2012, CDE was opensourced under the terms of the LGPL V2 license by
the Open Group.
You may reuse and redistribute this code under the terms of this
license. See the COPYING file for details.
# Downloading
Downloading this release:
CDE may be downloaded in source form from the Common Desktop
Environment website:
http://sourceforge.net/projects/cdesktopenv/
Or via git:
git clone git://git.code.sf.net/p/cdesktopenv/code CDE
The git repository will always be more up to date than the
downloadable tarballs we make available, so if you have problems,
please try the latest version from git master.
Note also that the master branch may be unstable, so your milage may
vary.
# Compiling
Complete build and installation instructions can be found on the CDE
wiki:
http://sourceforge.net/p/cdesktopenv/wiki/Home/
Please go there and read the appropriate section(s) for your OS (Linux
or FreeBSD/OpenBSD/NetBSD currently) prior to attmpting to build it.
There are a variety of dependencies that must be met, as well as
specific set up steps required to build, especially relating localization
and locales.
Do not expect to just type 'make' and have it actually work without
meeting the prerequisites and following the correct steps as spelled
out on the wiki.
There are also a lot of other documents and information there that you
might find useful.
Assuming you've met all of the requirements regarding packages needed
for the build, you can follow the standard autoconf method:
```
$ ./autogen.sh
$ ./configure
$ make
$ sudo make install
```
NOTE: BSD users must currently install and use gmake to compile, as
well as specify the location of the TCL libraries and headers. So
the instructions for them would looke like:
```
$ ./autogen.sh
$ ./configure --with-tcl=/usr/local/lib/tcl8.6 MAKE="gmake"
$ gmake
$ sudo gmake install
```
# Support
## Mailing list
https://lists.sourceforge.net/lists/listinfo/cdesktopenv-devel
## IRC
There is a CDE IRC channel on irc.libera.chat, channel #cde
## Patches welcome
Please see
https://sourceforge.net/p/cdesktopenv/wiki/Contributing%20to%20CDE/
for information on how to contribute.