Skip to content

Commit 4a70c62

Browse files
committed
Markdown README and updated CONTRIBUTORS
* And slightly reworked content * Use modified CONTRIBUTORS.md from Clojure * Add IntelliJ IDEA / Rider directory to .gitignore Signed-off-by: Anders Eknert <[email protected]>
1 parent 8035c96 commit 4a70c62

File tree

4 files changed

+77
-48
lines changed

4 files changed

+77
-48
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -304,6 +304,9 @@ paket-files/
304304
# CodeRush personal settings
305305
.cr/personal
306306

307+
# IntelliJ IDEA / Rider
308+
.idea
309+
307310
# Python Tools for Visual Studio (PTVS)
308311
__pycache__/
309312
*.pyc

CONTRIBUTING.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,23 @@
1-
If you'd like to submit a patch, please follow the [contributing guidelines](http://clojure.org/contributing).
1+
Hi! Thanks for your interest in ClojureCLR!
2+
3+
## I want to ask a question
4+
5+
If you have a question about ClojureCLR, please use the official Ask Clojure forum at https://ask.clojure.org,
6+
and the ClojureCLR [category](https://ask.clojure.org/index.php/clojureclr) specifically.
7+
This forum is monitored by the ClojureCLR maintainers.
8+
9+
## I want to discuss an idea
10+
11+
Great! Our preferred channel for discussions is the [#clr](https://clojurians.slack.com/archives/C060SFCPR) channel in the Clojurians Slack.
12+
13+
## I want to file a bug / suggest an enhancement
14+
15+
Please file it as a question in the ClojureCLR category on https://ask.clojure.org with the tag "problem" (possible bugs) or "request" (enhancements).
16+
17+
## I want to provide a patch / PR
18+
19+
If you would like to contribute patches, the Clojure dev process is described in detail at https://clojure.org/dev.
20+
21+
In short, this process requires:
22+
23+
- [Signing the Contributor Agreement](https://clojure.org/dev/contributor_agreement)

README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# ClojureCLR
2+
3+
This project is a native implementation of Clojure on the Common Language Runtime (CLR),
4+
the execution engine of Microsoft's .Net Framework.
5+
6+
ClojureCLR is programmed in C# (and Clojure itself).
7+
8+
## Goals
9+
10+
* Implement a feature-complete Clojure on top of CLR
11+
* Stay as close as possible to the JVM implementation
12+
* Have some fun
13+
14+
## Getting Started
15+
16+
ClojureCLR can either run as a a standalone application, or embedded as a library in .NET applications. See the
17+
[getting started](https://github.com/clojure/clojure-clr/wiki/Getting-started) guide for instructions on how to
18+
install, run or integrate ClojureCLR.
19+
20+
## Documentation
21+
22+
Most of the documentation for [Clojure](https://clojure.org/) should be equally applicable to ClojureCLR. See the
23+
ClojureCLR [wiki]((https://github.com/clojure/clojure-clr/wiki)) and the articles under the [docs](/docs) directory
24+
in this repository for documentation specific to the ClojureCLR project.
25+
26+
## Community and Support
27+
28+
* The [#clr](https://clojurians.slack.com/archives/C060SFCPR) channel in the [Clojurians Slack](https://clojurians.slack.com)
29+
* The [ClojureCLR](https://ask.clojure.org/index.php/clojureclr) category in [Ask Clojure](https://ask.clojure.org/)
30+
* [ClojureCLR JIRA](https://clojure.atlassian.net/jira/software/c/projects/CLJCLR/issues/) is used for issue tracking.
31+
Note that creating issues in the Clojure JIRA requires signing a
32+
[contributor agreement](https://clojure.org/dev/contributor_agreement). Minor issues might be easier to raise on Slack.
33+
34+
## Libraries
35+
36+
Many of the standard libraries from JVM Clojure have [CLR ports](https://github.com/orgs/clojure/repositories?q=clr).
37+
38+
## Other Resources
39+
40+
* [David Miller and Clojure on the CLR](https://soundcloud.com/defn-771544745/48-david-miller-and-clojure-on-the-clr) with [@dmiller](https://github.com/dmiller/)
41+
* [Transform Microsoft Office Solutions into Cloud-savvy Linked Data Microservices With Clojure on .NET](https://www.youtube.com/watch?v=pImaXoTPWWA) with [@bcalco](https://github.com/bcalco/)
42+
43+
## License ##
44+
45+
Copyright (c) Rich Hickey. All rights reserved. The use and
46+
distribution terms for this software are covered by the Eclipse
47+
Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php)
48+
which can be found in the file epl-v10.html at the root of this
49+
distribution. By using this software in any fashion, you are
50+
agreeing to be bound by the terms of this license. You must
51+
not remove this notice, or any other, from this software.

readme.txt

Lines changed: 0 additions & 47 deletions
This file was deleted.

0 commit comments

Comments
 (0)