Imported Upstream version 0.7.11
[platform/upstream/libsolv.git] / README
diff --git a/README b/README
index 3d3c58b..41fe168 100644 (file)
--- a/README
+++ b/README
@@ -1,23 +1,49 @@
+Libsolv
+=======
+
 This is libsolv, a free package dependency solver using a satisfiability
-algorihtm.
+algorithm.
+
+The code is based on two major, but independent, blocks:
+
+ 1. Using a dictionary approach to store and retrieve package and
+    dependency information in a fast and space efficient manner.
+
+ 2. Using satisfiability, a well known and researched topic, for
+    resolving package dependencies.
+
+The sat-solver code has been written to aim for the newest packages,
+record the decision tree to provide introspection, and also provides
+the user with suggestions on how to deal with unsolvable
+problems. It also takes advantage of repository storage to
+minimize memory usage.
+
+Supported package formats:
 
-This code is based on two major, but independent, blocks:
+  - rpm/rpm5
+  - deb
+  - arch linux
+  - haiku
 
-1. Using a dictionary approach to store and retrieve package
-   and dependency information.
+Supported repository formats:
 
-2. Using satisfiability, a well known and researched topic, for
-   resolving package dependencies.
+  - rpmmd (primary, filelists, comps, deltainfo/presto, updateinfo)
+  - susetags, suse product formats
+  - mandriva/mageia (synthesis, info, files)
+  - arch linux
+  - red carpet helix format
+  - haiku
 
-Google for 'sat solver' to get links to the theory behind it.
+Build instructions
+==================
 
-Requires: cmake 2.4.x
+Requires: cmake 2.8.5 or later
 
-mkdir build
-cd build
-cmake ..
-make
+    mkdir build
+    cd build
+    cmake ..
+    make
 
-To create a package:
-make srcpackage
-see package/
+////
+vim: syntax=asciidoc
+////