Updated the readme file

Mahmoud · Mahmoud · commit 32ff94d0b9c7 · 2011-06-03T13:36:22.000-05:00
diff --git a/BigInteger.cpp b/BigInteger.cpp
@@ -1,20 +1,20 @@
 /*
-	BigInteger Class, performs basic arithmetic operations of very large integers.
-	Copyright (C) 2011  Mahmoud Mechehoul
-
-	This program is free software: you can redistribute it and/or modify
-	it under the terms of the GNU General Public License as published by
-	the Free Software Foundation, either version 3 of the License, or
-	(at your option) any later version.
-
-	This program is distributed in the hope that it will be useful,
-	but WITHOUT ANY WARRANTY; without even the implied warranty of
-	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	GNU General Public License for more details.
-
-	You should have received a copy of the GNU General Public License
-	along with this program.  If not, see <http://www.gnu.org/licenses/>.
-*/
+ * BigInteger Class, performs basic arithmetic operations of very large integers.
+ * Copyright (C) 2011  Mahmoud Mechehoul
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
 
 #include <iostream>
 #include <algorithm>
diff --git a/BigInteger.h b/BigInteger.h
@@ -1,20 +1,20 @@
 /*
-	BigInteger Class, performs basic arithmetic operations of very large integers.
-	Copyright (C) 2011  Mahmoud Mechehoul
-
-	This program is free software: you can redistribute it and/or modify
-	it under the terms of the GNU General Public License as published by
-	the Free Software Foundation, either version 3 of the License, or
-	(at your option) any later version.
-
-	This program is distributed in the hope that it will be useful,
-	but WITHOUT ANY WARRANTY; without even the implied warranty of
-	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	GNU General Public License for more details.
-
-	You should have received a copy of the GNU General Public License
-	along with this program.  If not, see <http://www.gnu.org/licenses/>.
-*/
+ * BigInteger Class, performs basic arithmetic operations of very large integers.
+ * Copyright (C) 2011  Mahmoud Mechehoul
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
 
 #ifndef BIGINT_H_
 #define BIGINT_H_
diff --git a/README b/README
@@ -1 +1,44 @@
-This is a library that performs basic arithmetic operations on large intergers that would not normally fit in a 64 bits integer
+BigIntegerCPP, a C++ Big Integer Library
+----------------------------------------
+
+BigIntegerCPP is a C++ library that performs basic arithmetic operations on large intergers which would not normally fit in a 64 bits integer.
+
+### Status:
+
+At the present moment the library supports Big Integer Addition and Multiplication.
+In the future, I am planning to implement the Substraction and Division operations.
+Feel free to fork the project and add your own code. 
+
+### Test:
+
+	Run the following commands
+
+	make tests
+	./run_tests
+	
+### Usage:
+
+	// Create two big integers
+	BigInteger a("35742549198872617291353508656626642567");
+	BigInteger b("1298074214633706835075030044377087");
+	
+	// Perfom the addition and multiplication of the big integers
+	// and store the result in new objects
+	BigInteger c = a + b;
+	BigInteger d = a * b;
+
+	// Display the operands (Big Integers) and opration result (another Big Integer)
+	cout << a << " + " << b << " = " << c << endl;
+	cout << a << " * " << b << " = " << d << endl;
+	
+### Run Demo:
+
+	I have included a single file implementation for your convenience.
+	To run the demo uncomment the code in 'BigIntegerSingleFile' then run the following commands
+	
+	make demo
+	./demo
+	
+### Author:
+
+Mahmoud Mechehoul (http://mahmoud.devgator.com)
diff --git a/tests.cpp b/tests.cpp
@@ -1,20 +1,20 @@
 /*
-	BigInteger Class, performs basic arithmetic operations of very large integers.
-	Copyright (C) 2011  Mahmoud Mechehoul
-
-	This program is free software: you can redistribute it and/or modify
-	it under the terms of the GNU General Public License as published by
-	the Free Software Foundation, either version 3 of the License, or
-	(at your option) any later version.
-
-	This program is distributed in the hope that it will be useful,
-	but WITHOUT ANY WARRANTY; without even the implied warranty of
-	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	GNU General Public License for more details.
-
-	You should have received a copy of the GNU General Public License
-	along with this program.  If not, see <http://www.gnu.org/licenses/>.
-*/
+ * BigInteger Class, performs basic arithmetic operations of very large integers.
+ * Copyright (C) 2011  Mahmoud Mechehoul
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
 
 #include <iostream>
 #include <cstdlib>
