diff --git a/.gitignore b/.gitignore index 609f04b0..b12c6129 100644 --- a/.gitignore +++ b/.gitignore @@ -304,6 +304,9 @@ paket-files/ # CodeRush personal settings .cr/personal +# IntelliJ IDEA / Rider +.idea + # Python Tools for Visual Studio (PTVS) __pycache__/ *.pyc diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b37b3786..d46d2795 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1 +1,23 @@ -If you'd like to submit a patch, please follow the [contributing guidelines](http://clojure.org/contributing). \ No newline at end of file +Hi! Thanks for your interest in ClojureCLR! + +## I want to ask a question + +If you have a question about ClojureCLR, please use the official Ask Clojure forum at https://ask.clojure.org, +and the ClojureCLR [category](https://ask.clojure.org/index.php/clojureclr) specifically. +This forum is monitored by the ClojureCLR maintainers. + +## I want to discuss an idea + +Great! Our preferred channel for discussions is the [#clr](https://clojurians.slack.com/archives/C060SFCPR) channel in the Clojurians Slack. + +## I want to file a bug / suggest an enhancement + +Please file it as a question in the ClojureCLR category on https://ask.clojure.org with the tag "problem" (possible bugs) or "request" (enhancements). + +## I want to provide a patch / PR + +If you would like to contribute patches, the Clojure dev process is described in detail at https://clojure.org/dev. + +In short, this process requires: + +- [Signing the Contributor Agreement](https://clojure.org/dev/contributor_agreement) diff --git a/README.md b/README.md new file mode 100644 index 00000000..bd1f28ec --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +# ClojureCLR + +This project is a native implementation of Clojure on the Common Language Runtime (CLR), +the execution engine of Microsoft's .Net Framework. + +ClojureCLR is programmed in C# (and Clojure itself). + +## Goals + +* Implement a feature-complete Clojure on top of CLR +* Stay as close as possible to the JVM implementation +* Have some fun + +## Getting Started + +ClojureCLR can either run as a a standalone application, or embedded as a library in .NET applications. See the +[getting started](https://github.com/clojure/clojure-clr/wiki/Getting-started) guide for instructions on how to +install, run or integrate ClojureCLR. + +## Documentation + +Most of the documentation for [Clojure](https://clojure.org/) should be equally applicable to ClojureCLR. See the +ClojureCLR [wiki]((https://github.com/clojure/clojure-clr/wiki)) and the articles under the [docs](/docs) directory +in this repository for documentation specific to the ClojureCLR project. + +## Community and Support + +* The [#clr](https://clojurians.slack.com/archives/C060SFCPR) channel in the [Clojurians Slack](https://clojurians.slack.com) +* The [ClojureCLR](https://ask.clojure.org/index.php/clojureclr) category in [Ask Clojure](https://ask.clojure.org/) +* [ClojureCLR JIRA](https://clojure.atlassian.net/jira/software/c/projects/CLJCLR/issues/) is used for issue tracking. +Note that creating issues in the Clojure JIRA requires signing a +[contributor agreement](https://clojure.org/dev/contributor_agreement). Minor issues might be easier to raise on Slack. + +## Libraries + +Many of the standard libraries from JVM Clojure have [CLR ports](https://github.com/orgs/clojure/repositories?q=clr). + +## Other Resources + +* [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/) +* [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/) + +## License ## + + Copyright (c) Rich Hickey. All rights reserved. The use and + distribution terms for this software are covered by the Eclipse + Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php) + which can be found in the file epl-v10.html at the root of this + distribution. By using this software in any fashion, you are + agreeing to be bound by the terms of this license. You must + not remove this notice, or any other, from this software. \ No newline at end of file diff --git a/readme.txt b/readme.txt deleted file mode 100644 index b8747780..00000000 --- a/readme.txt +++ /dev/null @@ -1,47 +0,0 @@ -ClojureCLR - -This project is a native implementation of Clojure on the Common Language Runtime (CLR), -the execution engine of Microsoft's .Net Framework. - -ClojureCLR is programmed in C# (and Clojure itself). - - -Goals: - - -- Implement a feature-complete Clojure on top of CLR. - -- Stay as close as possible to the JVM implementation. - -- Have some fun. - - - --------------------------------------------------------------------------------------- - - -ClojureCLR Google group: https://groups.google.com/g/clojure-clr -Getting Started (ClojureCLR): https://github.com/clojure/clojure-clr/wiki/Getting-started -Gitter CLR chat room: https://gitter.im/clojure-clr/community -Bug reports: https://clojure.atlassian.net/jira/software/c/projects/CLJCLR/issues - -Main Clojure site: https://clojure.org/ - -For more information on ClojureCLR: https://github.com/clojure/clojure-clr/wiki - - - - - - --------------------------------------------------------------------------------------- - - * ClojureCLR - * Copyright (c) Rich Hickey. All rights reserved. - * The use and distribution terms for this software are covered by the - * Eclipse Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php) - * which can be found in the file epl-v10.html at the root of this distribution. - * By using this software in any fashion, you are agreeing to be bound by - * the terms of this license. - * You must not remove this notice, or any other, from this software. - - - -