8000 Enhance README and examples with detailed descriptions; add robots.tx… · FEAScript/FEAScript-platform@700f5e9 · GitHub
[go: up one dir, main page]
Ski 8000 p to content

Commit 700f5e9

Browse files
nikoschamnikoscham
committed
Enhance README and examples with detailed descriptions; add robots.txt and sitemap.xml for SEO
1 parent 995756c commit 700f5e9

File tree

6 files changed

+54
-3
lines changed

6 files changed

+54
-3
lines changed

‎NOTICE.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
FEAScript-platform makes use of the following third-party software:
2+
3+
1. **blockly**
4+
- License: Apache 2.0 License
5+
- Source: https://github.com/google/blockly
6+
- License: https://github.com/google/blockly/blob/develop/LICENSE
7+
8+
1. **tweakpane**
9+
- License: MIT license
10+
- Source: https://github.com/cocopon/tweakpane
11+
- License: https://github.com/cocopon/tweakpane/blob/main/LICENSE.txt

‎README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
# FEAScript-platform
44

5-
FEAScript-platform is a web-based interface for the FEAScript library, enabling users to create and run finite element simulations directly in their browser.
5+
FEAScript-platform is browser-based visual editor designed for the FEAScript finite element simulation library. It empowers users to create and run finite element simulations directly in their browser.
66

77
## License
88

9-
FEAScript-platform is released under the [MIT license](https://github.com/FEAScript/FEAScript-platform/blob/main/LICENSE). © 2025 FEAScript.
9+
FEAScript-platform is released under the [MIT license](https://github.com/FEAScript/FEAScript-platform/blob/main/LICENSE). © 2025 FEAScript.

‎examples/solidHeatTransferScript/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<img src="https://feascript.github.io/FEAScript-website/assets/FEAScriptHeatTransfer.png" width="80" alt="FEAScript Logo">
2+
3+
## Heat Conduction in a Two-Dimensional Fin (Visual Editor)
4+
5+
This example demonstrates solving a steady-state heat transfer problem in a 2D rectangular domain using the FEAScript-platform visual editor. The problem represents a typical cooling fin scenario, where heat conduction is modeled to understand temperature distribution under specific boundary conditions.
6+
7+
### Using the Example
8+
9+
This example is provided as an XML file (`HeatConduction2DFin.xml`) which can be directly loaded into the [FEAScript-platform](https://platform.feascript.com) visual editor:
10+
11+
1. Visit the [FEAScript-platform](https://platform.feascript.com) in your browser
12+
2. Click the "Load Project" button in the Control Panel
13+
3. Select the `HeatConduction2DFin.xml` file from your computer
14+
4. The blocks will be loaded into the editor, showing the complete simulation setup
15+
5. Click "Evaluate" in the Control Panel to run the simulation
16+
6. The results (temperature contour plot) will be displayed in the 'Solution' tab
17+
18+
### Related Examples
19+
20+
For JavaScript API implementations of the same problem, see:
21+
- [Core library examples](https://github.com/FEAScript/FEAScript-core/tree/main/examples/solidHeatTransferScript/HeatConduction2DFin)
22+
- [Online tutorial](https://feascript.com/tutorials/HeatConduction2DFin.html)

‎index.html

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,13 @@
1313
<html>
1414
<head>
1515
<!-- Page title -->
16-
<title>FEAScript Platform</title>
16+
<title>FEAScript-platform</title>
1717
<link rel="icon" type="image/x-icon" href="https://feascript.com/assets/favicon.ico" />
1818
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
19+
<meta
20+
name="description"
21+
content="FEAScript-platform is browser-based visual editor designed for the FEAScript finite element simulation library. It empowers users to create and run finite element simulations directly in their browser."
22+
/>
1923
<meta
2024
name="keywords"
2125
content="finite elements, fem, galerkin, cfd, computational mechanics, javascript"
@@ -142,8 +146,13 @@ <h1 class="top">
142146
</a>
143147
</h1>
144148

149+
<div class="highlight-container" style="text-align: center; margin-bottom: 15px; color: #856404;">
150+
🚧 <strong>FEAScript is currently under heavy development with new features being added regularly</strong>
151+
</div>
152+
145153
<ul id="menu">
146154
<li><a href="#help">Help</a></li>
155+
<li><a href="https://feascript.com" target="_blank">FEAScript Website</a></li>
147156
</ul>
148157

149158
<div id="controlPanelContainer"></div>

‎robots.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
User-agent: *
2+
Allow: /

‎sitemap.xml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
3+
<url>
4+
<loc>https://platform.feascript.com/</loc>
5+
<priority>1.0</priority>
6+
</url>
7+
</urlset>

0 commit comments

Comments
 (0)
0