aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorUwe Hermann2009-07-16 00:01:41 +0200
committerUwe Hermann2009-07-16 00:01:41 +0200
commite5c5371997cd1d5cdf69867fe634321f861470c1 (patch)
tree877dd22b3af664b1f369650d0336626e20c6c7a6 /README
parentb201bf19cb4db94980285deb3ae63307e47b80b0 (diff)
Add some more info to the README.
Diffstat (limited to 'README')
-rw-r--r--README55
1 files changed, 54 insertions, 1 deletions
diff --git a/README b/README
index 5c0c248..05cf1a3 100644
--- a/README
+++ b/README
@@ -3,5 +3,58 @@ README
------------------------------------------------------------------------------
The libopenstm32 project aims to create an open-source firmware library for
-STM32 microcontrollers...
+STM32 microcontrollers.
+
+
+Building
+--------
+
+ $ make
+
+
+Installation
+------------
+
+ $ make install
+
+This will install the library in /usr/local. If you want to install it
+elsewhere, use the following syntax:
+
+ $ DESTDIR=/opt make install
+
+
+Coding style
+------------
+
+The whole library is programmed using the Linux kernel coding style, see
+http://lxr.linux.no/linux/Documentation/CodingStyle for details.
+
+Please use the same style for any code contributions, thanks!
+
+
+License
+-------
+
+The libopenstm32 code is released under the terms of the GNU General
+Public License (GPL), version 2 or later.
+
+See COPYING for details.
+
+
+Mailing lists
+-------------
+
+ * Developer mailing list (for patches and discussions):
+ https://lists.sourceforge.net/lists/listinfo/libopenstm32-devel
+
+ * Commits mailing list (receives one mail per 'git push'):
+ https://lists.sourceforge.net/lists/listinfo/libopenstm32-commits
+
+
+Website
+-------
+
+The official website is:
+
+ https://sourceforge.net/projects/libopenstm32/